Skip to content

Commit

Permalink
docs: mention schedued backups in main page
Browse files Browse the repository at this point in the history
  • Loading branch information
robertsLando committed Aug 11, 2022
1 parent 7d0bf88 commit 3ad4af9
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 13 deletions.
29 changes: 16 additions & 13 deletions README.md
Expand Up @@ -24,25 +24,28 @@
<img src="docs/_images/MQTT-Logo.png" alt="mqtt">
</div>

Fully configurable Zwave to MQTT **Gateway** and **Control Panel**.
Fully configurable Z-Wave to MQTT **Gateway** and **Control Panel**.

- **Backend**: [NodeJS](https://nodejs.org/en/), [Express](https://expressjs.com/), [socket.io](https://github.com/socketio/socket.io), [Mqttjs](https://github.com/mqttjs/MQTT.js), [zwavejs](https://github.com/zwave-js/node-zwave-js), [Webpack](https://webpack.js.org/)
- **Frontend**: [Vue](https://vuejs.org/), [socket.io](https://github.com/socketio/socket.io), [Vuetify](https://github.com/vuetifyjs/vuetify)

## Main features

- **Zwave to Mqtt Gateway**: Configure how nodes and nodes values are mapped between the two protocols
- **Secured**: Supports *HTTPS* and users *authentication*
- **Control Panel UI**: Directly control all your nodes and their values from the UI, some of control panel features:
- *Nodes management*: check all nodes discovered in the z-wave network and manage their values
- *Firmware updates*: update devices firmware, just select the controller action `Begin Firmware Update` and upload the firmware file
- *Groups associations*: add/edit nodes associations
- *Full zwave-js APIs support*
- Custom **scenes management**: create scenes and trigger them by using MQTT apis (also supports timeouts)
- Log **debug in UI**: See debug logs directly from the UI
- **Store directory management**: all files are stored in `store` folder, you can download/edit files inside this folder directly from the UI
- **Network graph**: see how nodes are communicating with the controller, useful for diagnostics purposes
- **Home Assistant integration**: you can use official Zwavejs integration by enabling zwavejs server or use integrated MQTT discovery integration
- **Full-Featured Z-Wave to MQTT Gateway**: Expose Z-Wave devices to an MQTT broker in a fully configurable manner
- **Secured**: Supports *HTTPS* and *user authentication*
- **Control Panel UI**: Directly control your nodes and their values from the UI, including:
- *Nodes management*: Add, remove, and configure all nodes in your Z-Wave network
- *Firmware updates*: Update device firmware using manufacturer-supplied firmware files
- *Groups associations*: Add, edit, and remove direct node associations
- *Z-Wave JS Exposed*: Provides full-access to Z-Wave JS's APIs
- **Scene Management**: Create scenes and trigger them by using MQTT apis (with timeout support)
- **Debug Logs in the UI**: See debug logs directly from the UI
- **Access Store Files in the UI**: Access the files are stored in the persistent `store` folder directly from the UI
- **Network Graph**: Provides a beautiful map showing how nodes are communicating with the controller
- **Supports the Official Home Assistant Integration**: Can act as the backend driver for the official Home Assistant integration, using the same driver and socket server as the official addon
- **Supports Home Assistant Discovery via MQTT**: In lieu of the official integation, can be used to expose Z-Wave devices to Home Assistant via MQTT discovery.
- **Supported by Domoticz** (beta 2021.1) using MQTT Autodiscovery.
- **Automatic/Scheduled backups**: Scheduled backup of NVM and store directory. It's also possible to enable automatic backups of NVM before every node inclusion/exclusion/replace, this ensures to create a safe restore point before any operation that can cause a network corruption.

## Documentation

Expand Down
1 change: 1 addition & 0 deletions docs/README.md
Expand Up @@ -45,3 +45,4 @@ Fully configurable Z-Wave to MQTT **Gateway** and **Control Panel**.
- **Supports the Official Home Assistant Integration**: Can act as the backend driver for the official Home Assistant integration, using the same driver and socket server as the official addon
- **Supports Home Assistant Discovery via MQTT**: In lieu of the official integation, can be used to expose Z-Wave devices to Home Assistant via MQTT discovery.
- **Supported by Domoticz** (beta 2021.1) using MQTT Autodiscovery.
- **Automatic/Scheduled backups**: Scheduled backup of NVM and store directory. It's also possible to enable automatic backups of NVM before every node inclusion/exclusion/replace, this ensures to create a safe restore point before any operation that can cause a network corruption.

0 comments on commit 3ad4af9

Please sign in to comment.