NetAlertX/front/plugins/_publisher_mqtt/README.md

Overview

• Feed your data and device changes into Home Assistant via the MQTT Mosquito broker (other brokers might work as well).

Usage

• Go to settings and fill in relevant details. There are 2 types of "devices" generated and sent to the broker. A generic overview device that contains online/down/archived device stats and then the actual devices detected by the application.

Sample Payloads

Overview device

The below payloads apply to the device showing overall online/down/archived stats. You can toggle them on/off with the SEND_STATS setting.

MQTT discovery data:

Note

You can replace the netalertx string of the below topic via the DEVICE_ID setting.

Topic: homeassistant/sensor/netalertx/online/config

Note

You can replace the "name": "NetAlertX" string of the below payload via the DEVICE_NAME setting.

Payload:

{
  "name": "online",
  "state_topic": "system-sensors/sensor/netalertx/state",
  "value_template": "{{value_json.online}}",
  "unique_id": "netalertx_sensor_online",
  "device": {
    "identifiers": [
      "netalertx_sensor"
    ],
    "manufacturer": "NetAlertX",
    "name": "NetAlertX"
  },
  "icon": "mdi:wifi-check",
  "platform": "mqtt"
}

MQTT config data sample:

Note

You can replace the netalertx string of the below topic via the DEVICE_ID setting.

Topic: homeassistant/sensor/netalertx/all/config

Payload:

{
  "name": "all",
  "state_topic": "system-sensors/sensor/netalertx/state",
  "value_template": "{{value_json.all}}",
  "unique_id": "netalertx_sensor_all",
  "device": {
    "identifiers": [
      "netalertx_sensor"
    ],
    "manufacturer": "NetAlertX",
    "name": "NetAlertX"
  },
  "icon": "mdi:wifi",
  "platform": "mqtt"
}

MQTT state data:

Note

You can replace the netalertx string of the below topic via the DEVICE_ID setting.

Topic: system-sensors/sensor/netalertx/state

Payload:

{
  "online": 30,
  "down": 36,
  "all": 66,
  "archived": 0,
  "new": 0,
  "unknown": 0
}

Individual devices

The below payloads apply to individual devices. Every device discovered by the application will generate the below messages. You can toggle them on/off with the SEND_DEVICES setting.

MQTT discovery data:

Topic: homeassistant/sensor/mac_44_ef_44_ef_44_ef/last_ip/config

Payload:

{
  "name": "last_ip",
  "state_topic": "system-sensors/sensor/mac_44_ef_44_ef_44_ef/state",
  "value_template": "{{value_json.last_ip}}",
  "unique_id": "mac_44_ef_44_ef_44_ef_sensor_last_ip",
  "device": {
    "identifiers": [
      "mac_44_ef_44_ef_44_ef_sensor"
    ],
    "manufacturer": "NetAlertX",
    "name": "Camera - E1"
  },
  "icon": "mdi:ip-network",
  "platform": "mqtt"
}

MQTT state data:

Topic: system-sensors/sensor/mac_44_ef_44_ef_44_ef/state

Payload:

{
  "last_ip": "192.168.1.33",
  "is_new": "0",
  "vendor": "None",
  "mac_address": "44:ef:44:ef:44:ef"
}

Transmitted message examples:

Topic: homeassistant/binary_sensor/mac_44_ef_44_ef_44_ef/is_present/

Payload:

{
  "name": "is_present",
  "state_topic": "system-sensors/binary_sensor/mac_44_ef_44_ef_44_ef/state",
  "value_template": "{{value_json.is_present}}",
  "unique_id": "mac_44_ef_44_ef_44_ef_sensor_is_present",
  "device": {
    "identifiers": [
      "mac_44_ef_44_ef_44_ef_sensor"
    ],
    "manufacturer": "NetAlertX",
    "name": "Camera - E1"
  },
  "icon": "mdi:wifi",
  "platform": "mqtt"
}

Topic: system-sensors/binary_sensor/mac_44_ef_44_ef_44_ef/state

Payload:

{
  "is_present": "OFF"
}

{
  "is_present": "ON"
}

Warning

Please check your Home Assistant MQTT broker debug info for the most up-to-date data nad format as the above might be outdated.

Implementation Notes

The first run will take a while, subsequent should be much faster because new sensors don't have to be created anymore. If the first sync times out, try to increase the timeout setting (default: 10s per device). A bit of background:

1. The app keeps a hash of the sensors. The hash includes:
   • deviceId: Unique identifier for the device associated with the sensor.
   • deviceName: Name of the device.
   • sensorType: Type of sensor.
   • sensorName: Name of the sensor.
   • icon: Icon associated with the sensor.
2. This hash is compared to existing MQTT plugin object hashes, which can be found under Integrations > Plugins > MQTT (Plugin objects tab) > Hash
3. If the hash is not found, a new device/device state is assumed and the device is sent to the broker

The state is managed differently, the state of the sensor is not included in the hash. This might be improved upon in later releases.