Update DOCS.md
This commit is contained in:
habuild
GitHub
parent
1176d11d56
commit
a7fd427c48
1 changed files with 29 additions and 20 deletions
|
|
@ -1,19 +1,28 @@
|
|||
# Community Hass.io Add-ons: SBFspot
|
||||
# SBFspot addon for HAOS
|
||||
|
||||
![project-stage-shield] ![Project Maintenance][maintenance-shield]
|
||||
|
||||
|
||||
|
||||
![Project Maintenance][maintenance-shield] [](https://github.com/habuild/hassio-addons/actions/workflows/addon-ci.yaml)
|
||||
|
||||
[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg
|
||||
[maintenance-shield]: https://img.shields.io/maintenance/yes/2022.svg
|
||||
|
||||
|
||||
|
||||
[](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fhabuild%2Fhassio-addons)
|
||||
|
||||
This [home assistant](https://www.home-assistant.io/getting-started/) add-on provides the installation, configuration, and integration for the **Bluetooth** version of [SBFspot 3.9.4](https://github.com/SBFspot/SBFspot). This version is for the Container/supervised installation method of Home assistant. Although the haos version will also work here. Openrc is omitted in the HAOS version due to read only file system.
|
||||
This [home assistant](https://www.home-assistant.io/getting-started/) add-on provides a wrapper for the **Bluetooth** version of [SBFspot 3.9.5](https://github.com/SBFspot/SBFspot/releases/latest).
|
||||
|
||||
This add-on installs a cron service for SPFspot uploader at 5 minutely daytime interval, [PVoutput](https://pvoutput.org/) account and API are required, it also requires an SQL database like Mariadb.
|
||||
It also sends a MQTT message to home assistant, therefore a MQTT broker is required.
|
||||
This add-on runs a crontab service for SBFspot and SPFspotUploader at 5 minutely daytime interval.
|
||||
|
||||
# Installation
|
||||
[PVoutput](https://pvoutput.org/) account and API are required to use the upload feature.
|
||||
|
||||
[Mariadb addon](https://github.com/home-assistant/addons/tree/master/mariadb) or similiar SQL database, is needed to store the data for upload to PVOutput.
|
||||
|
||||
[phpMyAdmin](https://github.com/hassio-addons/addon-phpmyadmin) is required to create the DB structure.
|
||||
|
||||
[MQTT broker](https://github.com/home-assistant/addons/tree/master/mosquitto) is needed to send MQTT messages to home Assistant.
|
||||
|
||||
## Installation
|
||||
|
||||
### Initial database creation.
|
||||
|
||||
|
|
@ -23,37 +32,37 @@ Download and import either [No Drop DB create](https://github.com/habuild/hassio
|
|||
|
||||
### MQTT
|
||||
|
||||
[sbfspot_sensors.yaml](https://github.com/habuild/hassio-addons/blob/main/.images/sbfspot_sensors.yaml) I use packages to include these yaml sensors. You will need to change to match your plant name and serial as you have set in the add-on configuration options.
|
||||
[haos-sbfspot_sensors.yaml](https://github.com/habuild/hassio-addons/blob/main/.images/sbfspot_sensors.yaml) I use packages to include these yaml sensors. You will need to change to match your plant name and serial as you have set in the add-on configuration options.
|
||||
|
||||
**MQTT argument options** [configuration options](https://github.com/habuild/hassio-addons/blob/main/.images/Example_Config.yaml) The MQTT Username, and Password need to be hardcoded into the **MQTT_PublisherArgs:** The **{host}** **{topic}** and **{{message}}** will be picked up from options.
|
||||
**MQTT options argument** [configuration options](https://github.com/habuild/hassio-addons/blob/main/.images/Example_Config.yaml). The MQTT Username, and Password need to be hardcoded into the **MQTT_PublisherArgs:** The **{host}** **{topic}** and **{{message}}** will be picked up from options.
|
||||
|
||||
**MQTT_PublisherArgs:** **'-h {host} -u Your_MQTT_Username -P Your_MQTT_password -t {topic} -m "{{message}}" -d -r'**
|
||||
|
||||
**-d** is for MQTT debug in log. Helpful for showing the MQTT messages are actually being sent.
|
||||
**-d** is for MQTT debug in log. Which is helpful for confirming the MQTT messages are actually being sent.
|
||||
|
||||
**-r** is to retain messages. retain is not advised.
|
||||
**-r** is to retain messages. it is advised against using retain flag
|
||||
|
||||
### Example Configuration Options.
|
||||
|
||||
can be copy/pasted as [Example Config](https://github.com/habuild/hassio-addons/blob/main/.images/Example_Config.yaml) or entered via UI
|
||||
|
||||
can be copy/pasted as [Example Config](https://github.com/habuild/hassio-addons/blob/main/haos-sbfspot/.images/Example_Config.yaml) or entered via UI
|
||||
|
||||
|
||||
### Data paths
|
||||
|
||||
In docker the /data/ path arrives at /usr/share/hassio/addons/data/slug#\_sbfspot on the host.
|
||||
In HAOS (home assistant operating system) the /data/ path arrives at /mnt/data/supervisor/addons/data/{slug}\_haos-sbfspot on the host.
|
||||
|
||||
### Upload logs
|
||||
|
||||
The log file here may need to be cleaned up manually.
|
||||
Logs delete after 3 days now. You would need SSH with Root host access to find them anyway.
|
||||
|
||||
### **Link to SBFspot Documentation**
|
||||
### **Link to haos-sbfspot Documentation**
|
||||
|
||||
Refer to the [Wiki](https://github.com/SBFspot/SBFspot/wiki) for documentation and FAQ.
|
||||
Refer to the [SBFspot Wiki](https://github.com/sbfspot/sbfspot/wiki) for documentation and FAQ about SBFspot.
|
||||
|
||||
### **Special thanks to:**
|
||||
|
||||
- LauR3y/hassio-addons which this version is cleaned up from.
|
||||
- The SBFspot team for SPFspot.
|
||||
- LauR3y/hassio-addons-addons which this version is cleaned up from.
|
||||
- The sbfspot team for SPFspot.
|
||||
|
||||
![Supports aarch64 Architecture][aarch64-shield]
|
||||
![Supports armhf Architecture][armhf-shield]
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue