Skip to content

Commit

Permalink
Release v0.2.0, update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
azuwis committed Aug 22, 2019
1 parent 60a5ecd commit 83c9fd8
Showing 1 changed file with 19 additions and 3 deletions.
22 changes: 19 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,18 @@

## Home Assistant setup

Download [`zigbee2mqtt-networkmap.js`](https://github.com/azuwis/zigbee2mqtt-networkmap/releases/download/v0.1.0/zigbee2mqtt-networkmap.js) and put it into `<config-directory>/www/` directory.
Download [`zigbee2mqtt-networkmap.js`](https://github.com/azuwis/zigbee2mqtt-networkmap/releases/download/v0.2.0/zigbee2mqtt-networkmap.js) and put it into `<config-directory>/www/` directory.

In `configuration.yaml`:
``` yaml
sensor:
- platform: mqtt
name: Zigbee2mqtt Networkmap
# if you change base_topic of Zigbee2mqtt, change state_topic accordingly
state_topic: zigbee2mqtt/bridge/networkmap/raw
value_template: >-
{{ now().strftime('%Y-%m-%d %H:%M:%S') }}
# again, if you change base_topic of Zigbee2mqtt, change json_attributes_topic accordingly
json_attributes_topic: zigbee2mqtt/bridge/networkmap/raw

```
Expand All @@ -27,11 +29,12 @@ and in `ui-lovelace.yaml`:

``` yaml
resources:
- url: /local/zigbee2mqtt-networkmap.js?v=0.1.0
- url: /local/zigbee2mqtt-networkmap.js?v=0.2.0
type: module

views:
- title: Zigbee Network
panel: true # this renders the first card on full width, other cards in this view will not be rendered.
cards:
- type: custom:zigbee2mqtt-networkmap
entity: sensor.zigbee2mqtt_networkmap
Expand All @@ -40,14 +43,27 @@ views:
Full card default options:
``` yaml
mqtt_base_topic: zigbee2mqtt
mqtt_base_topic: zigbee2mqtt # if you change base_topic of Zigbee2mqtt, change it accordingly
force: 3000 # decrease it to get smaller map if you have many devices
node_size: 16
font_size: 12
link_width: 2
height: 400 # height of the card
```
## Upgrade
Replace `<config-directory>/www/zigbee2mqtt-networkmap.js` with new one, and
change version string in `ui-lovelace.yaml`:

``` yaml
resources:
- url: /local/zigbee2mqtt-networkmap.js?v=0.2.0 # change `v=0.1.0` to `v=0.2.0`
type: module
```
And then refresh the browser.
## Development
Install [nodejs](https://nodejs.org/) and [yarn](https://yarnpkg.com/), clone the
Expand Down

0 comments on commit 83c9fd8

Please sign in to comment.