From 83c9fd82633a1c564193ecc94fd7fd4b9580d165 Mon Sep 17 00:00:00 2001 From: Zhong Jianxin Date: Thu, 22 Aug 2019 09:33:30 +0800 Subject: [PATCH] Release v0.2.0, update README.md --- README.md | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e65c46f..156e3c3 100644 --- a/README.md +++ b/README.md @@ -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 `/www/` directory. +Download [`zigbee2mqtt-networkmap.js`](https://github.com/azuwis/zigbee2mqtt-networkmap/releases/download/v0.2.0/zigbee2mqtt-networkmap.js) and put it into `/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 ``` @@ -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 @@ -40,7 +43,7 @@ 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 @@ -48,6 +51,19 @@ Full card default options: height: 400 # height of the card ``` +## Upgrade + +Replace `/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