This home assistant add-on provides a wrapper for the Bluetooth version of
This add-on runs a crontab service for SBFspot and SPFspotUploader at 5 minutely daytime interval.
PVoutput account and API are required to use the upload feature.
Mariadb addon or similiar SQL database, is needed to store the data for upload to PVOutput.
phpMyAdmin is required to create the DB structure.
MQTT broker is needed to send MQTT messages to home Assistant.
If you want to template your options with secrets, the below template can be used.
These names auto default so you shouldn't need to confirm(save) any options on installation
It should all just default when starting the addon.
##template for secrets.yaml
## a restart might be required after Saving your secrets file
BTAddress: "" ## Inverter BT mac
SBFpassword: "" ## Inverter password
LocalBTAddress: "" # host BT mac - can be empty
SBFplantname: ""
mariadb_pw: ""
mqtt_user: ""
mqtt_pass: ""
home_lat: ""
home_long: ""
Timezone: ""
### IF YOU WANT TO SKIP PVoutput
pvoSID: "0123456789:12345" ### will default to fake if left empty
pvoAPIkey: "fake9364fake4545afke834fake" ### will default to fake if left empty
The above options are the only required options if you want to fill out the options manually.
OPTIONS Image
This option is only for Bluetooth multi-inverter systems.
Each inverter first needs to be run through the sensor create setting to enable the MQTT sensors. Each inverter needs to run through on it's BTAddress. (You may have to tweak the Plantname and topic slightly)
Once the sensors are created set the Sensor create option back to NO (Disable the sensor creation setting)
You can now enable MIS under the GUI or yaml options configuration.
MIS_Enabled: 1
The NET ID needs to be greater than 1 on all inverters.
PVoutput SIDs can be comma separated entries with Inverter serial and separate PVO account IDs.
eg. Inverter1:acc1,Inverter2:acc2
0123456789:12345,2222222222:54321
refer to Issue 42 for more info
The other options default automatically if blank. If you need to change the broker address, you can stil use the options.
MQTT Sensor list
Description available in the SBFspot config file.
- Default list of Sensors for MQTT_Data
PrgVersion,Plantname,Timestamp,SunRise,SunSet,InvSerial,InvName,InvTime,InvStatus,InvSwVer,InvClass,InvType,InvTemperature,EToday,ETotal,GridFreq,PACTot,PAC1,UAC1,IAC1,OperTm,FeedTm,PDCTot,UDC1,UDC2,IDC1,IDC2,PDC1,PDC2,BTSignal
- Current available list of sensors
PrgVersion,Plantname,Timestamp,SunRise,SunSet,InvSerial,InvName,InvTime,InvStatus,InvSwVer,InvClass,InvType,InvTemperature,InvGridRelay,EToday,ETotal,GridFreq,PACTot,PAC1,PAC2,PAC3,UAC1,UAC2,UAC3,IAC1,IAC2,IAC3,OperTm,FeedTm,PDCTot,PDC1,PDC2,PDC,UDC1,UDC2,UDC,IDC1,IDC2,IDC,BTSignal,BatTmpVal,BatVol,BatAmp,BatChaStt,InvWakeupTm,InvSleepTm,MeteringWOut,MeteringWIn,MeteringWTot
MQTT Image
It is advised to backup and/or disable existing yaml sensors to avoid naming conflicts.
No sensors. HAOS-SBFspot will run without generating sensors. It will use yaml or mqtt sensors.
-
Use this option if you want to keep your existing yaml energy sensor on the energy dashboard.
You can make new sensors. You can't convert the new sensors to keep the old energy dash values.
Create sensors. HAOS-SBFspot will automatically create sensors in the MQTT Integration.
It is advised to backup and/or disable existing yaml sensors to avoid naming conflicts.
Updating the new energy sensor to follow the old energy sensor on the energy dashboard is not possible in HA.
- This option will create topics using your plantname and inverter serial number
- homeassistant/sensor/sbfspot_{*Your Plantname*}/sbf_spot{*your inv serial*}{*SensorType*}/config
- homeassistant/sbfspot_{Your Plantname}/sbf_spot{Your Inv Serial} is the state_topic
Purge sensors. HAOS-SBFspot will send empty topics to your broker address to clear Retained topics.
- This will fail if you change topics between creating and purging sensors.
- You can use MQTT explorer or similar MQTT tool to manually remove the topics if this occurs.
Earlier versions and yaml mqtt sensors
haos-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 options argument configuration options 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'
Publisher arguments has been removed to allow for sensors
-d is for MQTT debug in log. Which is helpful for confirming the MQTT messages are actually being sent.
-r is to retain messages. it is advised against using retain flag
Download and import either No Drop DB create or Create My SQL.sql in phpMyAdmin to create your database. IF you haven't already created the database previously, use the NO Drop version. You will also need to add the Database and User/Password to MariaDB and allocate the port.
In HAOS (home assistant operating system) the /data/ path arrives at /mnt/data/supervisor/addons/data/{slug_haos-sbfspot} on the host.
In docker/supervisor the /data/ path arrives at /usr/share/hassio/addons/data/{slug_haos-sbfspot} on the host.
Refer to the SBFspot Wiki for documentation and FAQ about SBFspot.
- The sbfspot team for SPFspot.
