MQTT Topics STABLE
Below table is a description of all MQTT topics that might be of use by a user. Replace <panel_name> with the friendly
name of your NSPanel:
| Topic | Payload | Description |
|---|---|---|
| nspanel/<panel_name>/screen_cmd | 1 or 0 | Send a 1 or 0 to turn on/off the display. |
| nspanel/<panel_name>/screen_state | 1 or 0 | Current state of the screen. |
| nspanel/<panel_name>/brightness | 1 to 100 | Control the brightness of the screen. |
| nspanel/<panel_name>/brightness_screensaver | 0 to 100 | Control the brightness of the screensaver. |
| nspanel/<panel_name>/r1_cmd | 1 or 0 | Send a 1 or 0 to turn on/off relay 1. |
| nspanel/<panel_name>/r1_state | 1 or 0 | The current state of relay 1. |
| nspanel/<panel_name>/r2_cmd | 1 or 0 | Send a 1 or 0 to turn on/off relay 2. |
| nspanel/<panel_name>/r2_state | 1 or 0 | The current state of relay 2. |
| nspanel/<panel_name>/temperature_state | Current temperature | The current temperature reading. |
| nspanel/<panel_name>/screensaver_mode | screensaver mode | Select what screensaver to display Choose from the following: - with_background -without_background -datetime_with_background -datetime_without_background or no_screensaver |
| nspanel/<panel_name>/log | Log message | The panel will send live logs on this topic. |
There are more topics that are used internally, these are:
| Topic | Payload | Description |
|---|---|---|
| nspanel/entities/<type>/<id>/state_<attribute> | The value of the attribute | An update of entity state value sent out by MQTTManager. Example:nspanel/entities/light/42/state_kelvin |
| nspanel/status/time | Time as a string | Current time sent by MQTTManager. |
| nspanel/status/weather | JSON | A JSON representation of the current weather and weather forecast. |
| nspanel/<panel_name>/status_report | JSON | JSON payload with current state of the panel. |
| nspanel/<panel_name>/status | JSON | JSON payload with current online/offline state of the panel. |
| nspanel/<panel_name>/command | JSON | JSON payload with a command for the panel to execute. |
| nspanel/mqttmanager/command | JSON | JSON payload from panel with a command for MQTTManager to perform. |
MQTT Topics BETA
Below table is a description of all MQTT topics that might be of use by a user. Replace <mac> with the MAC-address of your NSPanel:
| Topic | Payload | Description |
|---|---|---|
| nspanel/<mac>/screen_cmd | 1 or 0 | Send a 1 or 0 to turn on/off the display. |
| nspanel/<mac>/screen_state | 1 or 0 | Current state of the screen. |
| nspanel/<mac>/brightness_cmd | 1 to 100 | Control the brightness of the screen. |
| nspanel/<mac>/brightness_state | 1 to 100 | Current state of the brightness of the screen. |
| nspanel/<mac>/brightness_screensaver_cmd | 0 to 100 | Control the brightness of the screensaver. |
| nspanel/<mac>/brightness_screensaver_state | 0 to 100 | State of the brightness of the screensaver. |
| nspanel/<mac>/relay1_cmd | 1 or 0 | Send a 1 or 0 to turn on/off relay 1. |
| nspanel/<mac>/relay1_state | 1 or 0 | The current state of relay 1. |
| nspanel/<mac>/relay2_cmd | 1 or 0 | Send a 1 or 0 to turn on/off relay 2. |
| nspanel/<mac>/relay2_state | 1 or 0 | The current state of relay 2. |
| nspanel/<mac>/temperature | Current temperature | The current temperature reading. |
| nspanel/<mac>/screensaver_mode_cmd | screensaver mode | Select what screensaver to display Choose from the following: - with_background -without_background -datetime_with_background -datetime_without_background or no_screensaver |
| nspanel/<mac>/screensaver_mode_state | screensaver mode | The currently selected screensaver mode |
| nspanel/<mac>/log | Log message | The panel will send live logs on this topic. |
Below are more topics that are used internally. Replace <manager_address> with the IP address of the manager container.
| Topic | Payload | Description |
|---|---|---|
| nspanel/mqttmanager_<manager_address>/status/time | Time as a string | Current time sent by MQTTManager. |
| nspanel/mqttmanager_<manager_address>/status/date | Date as a string | Current date sent by MQTTManager. |
| nspanel/mqttmanager_<manager_address>/status/weather | Protobuf | A protobuf representation of the current weather and weather forecast. |
| nspanel/<mac>/status_report | Protobuf | Protobuf payload with current state of the panel. |
| nspanel/<mac>/status | JSON | JSON payload with current online/offline state of the panel. |
| nspanel/<mac>/command | JSON | JSON payload with a command for the panel to execute. |
| nspanel/mqttmanager_<manager_address>/command | Protobuf | Protobuf payload from panel with a command for MQTTManager to perform. |
| nspanel/mqttmanager_<manager_address>/room/<room_id>/state | Protobuf | Protobuf payload from the manager that represents the "Home page" state to display on the NSPanel for the given room. |
| nspanel/mqttmanager_<manager_address>/all_rooms_state | Protobuf | Protobuf payload from the manager that represents the "Home page" state to display on the NSPanel when in "All rooms" mode. |
| nspanel/mqttmanager_<manager_address>/all_rooms_state | Protobuf | Protobuf payload from the manager that represents the "Home page" state to display on the NSPanel when in "All rooms" mode. |
| nspanel/mqttmanager_<manager_address>/entity_pages/<page_id>/state | Protobuf | Protobuf payload from the manager that represents the "Entities"/"Scenes" state to display on the NSPanel when. |
| nspanel/mqttmanager_<manager_address>/relay_groups/<group_id>/state | 1 or 0 | Current state of the relay group binding 1 for "ON" and 0 for "OFF". |
| nspanel/mqttmanager_<manager_address>/entities/lights/<light_id>/state | Protobuf | Current state of the light. |