Skip to content

Latest commit

 

History

History
211 lines (160 loc) · 9.39 KB

Config.md

File metadata and controls

211 lines (160 loc) · 9.39 KB
Raw

Config

Found in /src/config/config.json. Properties not required can be null

MQTT

...
    "mqtt": {
        "host": "192.168.1.2",
        "port": 1883,
        "keepalive": 60,
        "protocol": 5,
        "clientId": "sec_1673108642",

        "topics": {
            "readPower": "power/xxx-xxx-xxx/tele/SENSOR",
            "writeCommand": "solar/xxx/cmd/limit_nonpersistent_relative",
            "inverterStatus": "solar/xxx/status/producing"
        },

        "auth": {
            "username": "my-user",
            "password": "my-password"
        }
    },
...

MQTT Properties

Setup basic mqtt properties

Req Property Type Default Description
🔴 mqtt.host string hostname or IP address of the remote broker
mqtt.port int 1883 network port of the server host to connect to
mqtt.keepalive int 60 maximum period in seconds allowed between communications with the broker
mqtt.protocol int 4 version of the mqtt protocol to use. MQTTv31 = 3, MQTTv311 = 4, MQTTv5 = 5
🟡 mqtt.clientId string solar-export-control mqtt client id to use, required if multiple instances of this program are running
🔴 mqtt.topics object controls mqtt topics
mqtt.auth object null controls mqtt auth

MQTT.TOPICS Properties

Setup mqtt topics

Req Property Type Description
🔴 topics.readPower string MQTT-Topic to read current power draw
topics.writeCommand string MQTT-Topic to write power limit command to
topics.inverterStatus string MQTT-Topic to listens for inverter status updates. This allows to sleep when the inverter is not producing

MQTT.AUTH Properties

Setup mqtt broker authentication. Will only be used If username is not empty

Req Property Type Default Description
🔴 auth.username string set a username for broker authentication
auth.password string null set a password for broker authentication


COMMAND

...
    "command": {
        "target": -100,
        "minPower": 24,
        "maxPower": 1200,
        "type": "relative",
        "throttle": 6,
        "hysteresis": 24.0,
        "retransmit": 0,
        "defaultLimit": null
    },
...

COMMAND Properties

Setup how commands will be issued

Req Property Type Unit Description
🔴 command.target int Watt (W) power consumption this app will use as target. Typical values are 0 (Zero Export) or -600 (in Germany "Balkonkraftwerk")
🔴 command.minPower int Watt (W) the lower power limit the inverter can be set to
🔴 command.maxPower int Watt (W) the upper power limit the inverter can be set to
🔴 command.type string: "absolute" or "relative" controls wether the limit command is absolute in watts (W) or in relative percent of command.maxPower
🔴 command.throttle int Seconds (s) minimum amount of time that must pass after a limit command has been issued before a new one can be issued. Use 0 to disable
🔴 command.hysteresis number Watt (W) minimum threshold that must been reached after a limit command has been issued before a new one can be issued. Use 0.00 to disable
🔴 command.retransmit int Seconds time after which command.hysteresis is ignored to retransmit the limit command. Useful if commands can get 'lost' on the way to the inverter. Use 0 to disable
command.defaultLimit int Watt (W) default inverter limit which is used during startup as calibration and if meta.resetInverterLimitOnInactive is active


READING

...
    "reading": {
        "offset": 0,
        "smoothing": "avg",
        "smoothingSampleSize": 8
    },
...

READING Properties

Setup how power reading will be handled

Req Property Type Default Description
reading.offset int 0 specifiy an offset in watts (W) to add or subtract
reading.smoothing string: "avg" or null null - null: original power reading will be used
- avg: average of reading.smoothingSampleSize is used
Use avg to filter short power spikes
reading.smoothingSampleSize int 0 amount of samples to use for reading.smoothing when not none


META

...
    "meta": {
        "prefix": "solarexportcontrol",
        "resetInverterLimitOnInactive": true,

        "telemetry": {
            "power": true,
            "sample": true,
            "overshoot": true,
            "limit": true,
            "command": true
        },

        "homeAssistantDiscovery": {
            "enabled": true,
            "discoveryPrefix": "homeassistant",
            "id": 1,
            "name": "SEC"
        }
    },
...

META Properties

Setup how this application can be controlled and how it publishes telemetry

Req Property Type Description
🔴 meta.prefix string prefix used for every mqtt topic managed by this application
🔴 meta.resetInverterLimitOnInactive bool should the inverter limit be reset to max when application is disabled?
🔴 meta.telemtry object manages the information which are published as mqtt topics
🔴 meta.homeAssistantDiscovery object manages the home assistant auto discovery

META.TELEMETRY Properties

Setup which values are published as telemetry

Req Property Type Unit Description
🔴 telemetry.power bool Watt (W) outputs the raw power value as parsed from mqtt.topics.readPower
🔴 telemetry.sample bool Watt (W) outputs the power value after applying reading.offset and reading.smoothing
🔴 telemetry.overshoot bool Watt (W) outputs the difference between the last sample and command.target
🔴 telemetry.limit bool Watt (W) outputs the calculated inverter limit
🔴 telemetry.command bool Watt (W) or Percent (%) outputs the last issued inverter limit command as published in mqtt.topics.writeCommand. Watt if command.type is absolute, percent if relative

META.HOMEASSISTANTDISCOVERY

Setup the home assistant integration (auto discovery of telemetry)

Req Property Type Description
🔴 homeAssistantDiscovery.enabled bool enables or disables the integration
🔴 homeAssistantDiscovery.discoveryPrefix string sets home assistant auto discovery topic prefix. Use homeassistant unless you have changed this in home assistant
🔴 homeAssistantDiscovery.id int used for creating the unique id in home assistant. Only change this if you run multiple instances of this program
🔴 homeAssistantDiscovery.name string the name of the device and entites in home assistant

CUSTOMIZE

...
"customize": {
    "command": {}
}
...

CUSTOMIZE Properties

Specify arbitrary data to pass to customize.py functions

Req Property Type Default Description
customize.command object (empty) object data passed to command_to_generic in customize.py