Skip to content

Commit

Permalink
Merge pull request #12 from lbouriez/master
Browse files Browse the repository at this point in the history
Olen changes + Fixes + HACS update
  • Loading branch information
RodBr committed Jun 6, 2020
2 parents d078c71 + 41cff27 commit 889ee81
Show file tree
Hide file tree
Showing 8 changed files with 258 additions and 220 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
/node_modules/
package-lock.json
/dist
39 changes: 26 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
[![hacs_badge](https://img.shields.io/badge/HACS-Custom-orange.svg?style=for-the-badge)](https://github.com/custom-components/hacs)


# MiFlora Card

A Home Assistant Lovelace card to report MiFlora sensors

![miflora-card](miflora-card.jpg)

![miflora-card](https://github.com/lbouriez/lovelace-miflora-card/raw/master/miflora-card.png)

## Options

| Name | Type | Default | Description |
| Name | Type | Requirement | Description |
| ---------------- | ------- | ------------ | --------------------------------------------- |
| type | string | **Required** | `custom:miflora-card` |
| title | string | **Required** | Name of the plant being monitored |
Expand All @@ -18,17 +20,23 @@ A Home Assistant Lovelace card to report MiFlora sensors
| min_temperature | integer | Optional | Minimum temperature for this plant |
| entities | list | **Required** | A list sensors to be monitored |

### Entities

| Name | Type | Requirement | Description |
| ---------------- | ------- | ------------ | --------------------------------------------- |
| entity | string | **Required** | Entity ID |
| type | string | **Required** | Type of entity |
| name | string | Optional | Custom name if you want to change it |

## Installation

1. Install the `miflora-card` component by copying `miflora-card.js` to `<config directory>/www/miflora-card.js`
## Installation

Use [HACS](https://hacs.xyz) or follow this [guide](https://github.com/thomasloven/hass-config/wiki/Lovelace-Plugins)

2. Link `miflora-card` inside your `ui-lovelace.yaml`

```yaml
resources:
- url: /local/miflora-card.js
- url: /hacsfiles/lovelace-miflora-card/miflora-card.js
type: js
```

Expand All @@ -43,10 +51,15 @@ resources:
min_conductivity: 350
min_temperature: 12
entities:
- moisture:sensor.miflora_1_moisture
- intensity:sensor.miflora_1_light_intensity
- temperature:sensor.miflora_1_temperature
- conductivity:sensor.miflora_1_conductivity
- battery:sensor.miflora_1_battery

- entity: sensor.miflora_1_moisture
type: moisture
- entity: sensor.miflora_1_light_intensity
type: intensity
- entity: sensor.miflora_1_temperature
type: temperature
- entity: sensor.miflora_1_conductivity
type: conductivity
name: Fertility
- entity: sensor.miflora_1_battery
type: battery
```
22 changes: 22 additions & 0 deletions changelog.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,24 @@
##v0.1
- Initial release with version tracking


# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

## [0.1.1] - 2020-05-10

### Updated

- Minor fixes

## [0.1.0] - 2019-07-19

### Added

- Initial release with version tracking
5 changes: 5 additions & 0 deletions hacs.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"name": "MiFlora Card",
"render_readme": true,
"filename": "miflora-card.js"
}
Binary file removed miflora-card.jpg
Binary file not shown.

0 comments on commit 889ee81

Please sign in to comment.