Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jollyjinx/sma2mqtt
sma2mqtt - autodiscover and publish SMA inverters and Sunny Home Manager to MQTT. Docker container provided.
https://github.com/jollyjinx/sma2mqtt
home-assistant inverter mqtt netspot node-red sma speedwire sunny-home-manager
Last synced: 4 months ago
JSON representation
sma2mqtt - autodiscover and publish SMA inverters and Sunny Home Manager to MQTT. Docker container provided.
- Host: GitHub
- URL: https://github.com/jollyjinx/sma2mqtt
- Owner: jollyjinx
- License: mit
- Created: 2021-02-24T12:24:34.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-03-22T09:09:48.000Z (10 months ago)
- Last Synced: 2024-09-28T14:01:21.771Z (4 months ago)
- Topics: home-assistant, inverter, mqtt, netspot, node-red, sma, speedwire, sunny-home-manager
- Language: Swift
- Homepage:
- Size: 1.78 MB
- Stars: 10
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## sma2mqtt Overview
The __sma2mqtt__ tool is designed to discover SMA devices, such as inverters and Sunny HomeManagers, on a local network. It identifies the data these devices can publish and subsequently delivers this information to an MQTT server.
Within the local network, __sma2mqtt__ joins the SMA multicast to listen to announcements from Sunny HomeManager. Please note, this functionality is strictly limited to the local network due to the inherent restrictions of multicast.
The repository includes a build.sh shell script that constructs a Docker container encapsulating the __sma2mqtt__ tool. It's likely necessary to adjust this script to suit the specifics of individual Docker setups.
Upon execution, __sma2mqtt__ produces output on MQTT similar to the one shown on the left, which in turn can be used to drive a node-red dashboard shown on the right.
## Docker Container Use
A Docker image, specifically engineered for 64-bit ARM architecture, is available. This image is compatible with a range of devices, including the Raspberry Pi, Apple Silicon Macs, and other 64-bit ARM computers. It can be employed directly using the following command:
```
docker run --name "sma2mqtt" --net service16 jollyjinx/sma2mqtt:latest sma2mqtt --inverter-password MySimplePassword
```
The --net option is included in this command to specify a separate network for SMA devices. If there is no dedicated network in use, port 9522 should be open for the container.
## Usage
```
USAGE: sma2mqtt
OPTIONS:
--log-level Set the log level. (default: debug)
--json-output send json output to stdout
--mqtt-servername
MQTT Server hostname (default: mqtt)
--mqtt-port MQTT Server port (default: 1883)
--mqtt-username
MQTT Server username (default: mqtt)
--mqtt-password
MQTT Server password
-e, --emit-interval
Minimum Emit Interval to send updates to mqtt Server. (default: 1.0)
-b, --basetopic
MQTT Server topic. (default: example/sma/)
--bind-address
Multicast Binding Listening Interface Address. (default: 0.0.0.0)
--bind-port Multicast Binding Listening Port number. (default: 9522)
--mcast-address
Multicast Group Address. (default: 239.12.255.254)
--mcast-port
Multicast Group Port number. (default: 9522)
--inverter-password
Inverter Password. (default: 0000)
--interesting-paths-and-values
Array of path:interval values we are interested in (default: dc-side/dc-measurements/power:2, ac-side/grid-measurements/power:2, ac-side/measured-values/daily-yield:30, battery/state-of-charge:20, battery/battery/temperature:30,
battery/battery-charge/battery-charge:20)
-h, --help Show help information.
```
The option __--interesting-paths-and-values__ is currently defaulted to the things I like to see, but you probably have different needs. To find out what your inverter supports you can use the catch all argument __\*:600__ which will show all paths your inverter supports.
__sma2mqtt__ does support signaling. When you send:
- __SIG_USR1__: it switches the log level between trace/debug/info.
- __SIG_USR2__: it prints the description of the SMALighthouse object including all currently used SMADevices and their state.
So you can use ```killall -USR2 sma2mqtt``` in a shell to let __sma2mqtt__ print out the SMALighthouse status.