IOT Link is a full featured service for connecting devices with IOT enabled services using MQTT.

Information

This Addon sends peridic information about the host machine to a specific topic group.

Publishing Topics

This addon will send information to the following topics:

General Status

Computer - IOT Link LWT

Topic: {prefix}/{domainName}/{machineName}/lwt
IOTLink Version: 1.0.0
Payload Type: ON/OFF
Payload Example: ON

Home Assistant:

binary_sensor:
  - platform: mqtt
    name: "My Computer - Connected"
    state_topic: "iotlink/workgroup/my-computer/lwt"
    value_template: "{{ value }}"
    payload_on: "ON"
    payload_off: "OFF"
    device_class: "connectivity"
    qos: 1

Computer - Power Status

Topic: {prefix}/{domainName}/{machineName}/windows-monitor/stats/power/status
IOTLink Version: 1.0.0
Payload Type: ON/OFF
Payload Example: ON

Home Assistant:

binary_sensor:
  - platform: mqtt
    name: "My Computer - Charging"
    state_topic: "iotlink/workgroup/my-computer/windows-monitor/stats/power/status"
    value_template: "{{ value }}"
    payload_on: "Online"
    payload_off: "Offline"
    device_class: "plug"
    availability_topic: "iotlink/workgroup/my-computer/lwt"
    payload_available: "ON"
    payload_not_available: "OFF"
    qos: 1

Computer - Battery Status

Topic: {prefix}/{domainName}/{machineName}/windows-monitor/stats/battery/status
IOTLink Version: 1.0.0
Payload Type: ON/OFF
Payload Example: ON

Home Assistant:

binary_sensor:
  - platform: mqtt
    name: "My Computer - Battery Status"
    state_topic: "iotlink/workgroup/my-computer/windows-monitor/stats/battery/status"
    value_template: "{{ value }}"
    payload_on: "Online"
    payload_off: "Offline"
    device_class: "plug"
    availability_topic: "iotlink/workgroup/my-computer/lwt"
    payload_available: "ON"
    payload_not_available: "OFF"
    qos: 1

System Sensors

Computer - Current User

Topic: {prefix}/{domainName}/{machineName}/windows-monitor/stats/system/current-user
IOTLink Version: 1.2.0
Payload Type: String
Payload Example: my_user

Home Assistant:

sensor:
  - platform: mqtt
    name: "My Computer - Current User"
    state_topic: "iotlink/workgroup/my-computer/windows-monitor/stats/system/current-user"
    unit_of_measurement: ''
    icon: mdi:account
    value_template: "{{ value }}"
    availability_topic: "iotlink/workgroup/my-computer/lwt"
    payload_available: "ON"
    payload_not_available: "OFF"
    qos: 1

Computer - Idle Time (Seconds)

Topic: {prefix}/{domainName}/{machineName}/windows-monitor/stats/system/idle-time
IOTLink Version: 1.1.1
Payload Type: Integer
Payload Example: 9999

Home Assistant:

sensor:
  - platform: mqtt
    name: "My Computer - Idle Time"
    state_topic: "iotlink/workgroup/my-computer/windows-monitor/stats/system/idle-time"
    unit_of_measurement: 'seconds'
    icon: mdi:timer
    value_template: "{{ value }}"
    availability_topic: "iotlink/workgroup/my-computer/lwt"
    payload_available: "ON"
    payload_not_available: "OFF"
    qos: 1

Computer - Uptime (Seconds)

Topic: {prefix}/{domainName}/{machineName}/windows-monitor/stats/system/uptime
IOTLink Version: 1.3.0
Payload Type: Integer
Payload Example: 9999

Home Assistant:

sensor:
  - platform: mqtt
    name: "My Computer - Up Time"
    state_topic: "iotlink/workgroup/my-computer/windows-monitor/stats/system/uptime"
    unit_of_measurement: 'seconds'
    icon: mdi:timer
    value_template: "{{ value }}"
    availability_topic: "iotlink/workgroup/my-computer/lwt"
    payload_available: "ON"
    payload_not_available: "OFF"
    qos: 1

Computer - Boot Time (yyyy-MM-dd HH:mm:ss)

Topic: {prefix}/{domainName}/{machineName}/windows-monitor/stats/system/boot-time
IOTLink Version: 1.3.0
Payload Type: Integer
Payload Example: 2019-12-31 23:59:59

Home Assistant:

sensor:
  - platform: mqtt
    name: "My Computer - Boot Time"
    state_topic: "iotlink/workgroup/my-computer/windows-monitor/stats/system/boot-time"
    icon: mdi:timer
    value_template: "{{ value }}"
    availability_topic: "iotlink/workgroup/my-computer/lwt"
    payload_available: "ON"
    payload_not_available: "OFF"
    qos: 1

CPU Sensors

CPU - Usage (%)

Topic: {prefix}/{domainName}/{machineName}/windows-monitor/stats/cpu/usage
IOTLink Version: 1.0.0
Payload Type: Integer
Payload Example: 10

Home Assistant:

sensor:
  - platform: mqtt
    name: "My Computer - CPU Usage"
    state_topic: "iotlink/workgroup/my-computer/windows-monitor/stats/cpu/usage"
    unit_of_measurement: '%'
    icon: mdi:speedometer
    value_template: "{{ value }}"
    availability_topic: "iotlink/workgroup/my-computer/lwt"
    payload_available: "ON"
    payload_not_available: "OFF"
    qos: 1

Memory Sensors

Memory - Usage (%)

Topic: {prefix}/{domainName}/{machineName}/windows-monitor/stats/memory/usage
IOTLink Version: 1.0.0
Payload Type: Integer
Payload Example: 47

Home Assistant:

sensor:
  - platform: mqtt
    name: "My Computer - RAM Usage"
    state_topic: "iotlink/workgroup/my-computer/windows-monitor/stats/memory/usage"
    unit_of_measurement: '%'
    icon: mdi:memory
    value_template: "{{ value }}"
    availability_topic: "iotlink/workgroup/my-computer/lwt"
    payload_available: "ON"
    payload_not_available: "OFF"
    qos: 1

Memory - Available (MB)

Topic: {prefix}/{domainName}/{machineName}/windows-monitor/stats/memory/available
IOTLink Version: 1.0.0
Payload Type: Integer
Payload Example: 8454

Home Assistant:

sensor:
  - platform: mqtt
    name: "My Computer - RAM Available"
    state_topic: "iotlink/workgroup/my-computer/windows-monitor/stats/memory/available"
    unit_of_measurement: 'MB'
    icon: mdi:memory
    value_template: "{{ value }}"
    availability_topic: "iotlink/workgroup/my-computer/lwt"
    payload_available: "ON"
    payload_not_available: "OFF"
    qos: 1

Memory - Used (MB)

Topic: {prefix}/{domainName}/{machineName}/windows-monitor/stats/memory/used
IOTLink Version: 1.0.0
Payload Type: Integer
Payload Example: 7792

Home Assistant:

sensor:
  - platform: mqtt
    name: "My Computer - RAM Used"
    state_topic: "iotlink/workgroup/my-computer/windows-monitor/stats/memory/used"
    unit_of_measurement: 'MB'
    icon: mdi:memory
    value_template: "{{ value }}"
    availability_topic: "iotlink/workgroup/my-computer/lwt"
    payload_available: "ON"
    payload_not_available: "OFF"
    qos: 1

Memory - Total (MB)

Topic: {prefix}/{domainName}/{machineName}/windows-monitor/stats/memory/total
IOTLink Version: 1.0.0
Payload Type: Integer
Payload Example: 16246

Home Assistant:

sensor:
  - platform: mqtt
    name: "My Computer - RAM Total"
    state_topic: "iotlink/workgroup/my-computer/windows-monitor/stats/memory/total"
    unit_of_measurement: 'MB'
    icon: mdi:memory
    value_template: "{{ value }}"
    availability_topic: "iotlink/workgroup/my-computer/lwt"
    payload_available: "ON"
    payload_not_available: "OFF"
    qos: 1

Battery Sensors

Battery - Remaining (%)

Topic: {prefix}/{domainName}/{machineName}/windows-monitor/stats/battery/remaining-percent
IOTLink Version: 1.1.1
Payload Type: Integer
Payload Example: 100

Home Assistant:

sensor:
  - platform: mqtt
    name: "My Computer - Remaining Battery"
    state_topic: "iotlink/workgroup/my-computer/windows-monitor/stats/battery/remaining-percent"
    unit_of_measurement: '%'
    device_class: battery
    value_template: "{{ value }}"
    availability_topic: "iotlink/workgroup/my-computer/lwt"
    payload_available: "ON"
    payload_not_available: "OFF"
    qos: 1

Battery - Remaining Time (seconds)

Topic: {prefix}/{domainName}/{machineName}/windows-monitor/stats/battery/remaining-time
IOTLink Version: 1.1.1
Payload Type: Integer
Payload Example: 9999

Home Assistant:

sensor:
  - platform: mqtt
    name: "My Computer - Remaining Battery Time"
    state_topic: "iotlink/workgroup/my-computer/windows-monitor/stats/battery/remaining-time"
    unit_of_measurement: 'minutes'
    icon: mdi:timer
    value_template: "{{ ( value | float / 60 ) | int }}"
    availability_topic: "iotlink/workgroup/my-computer/lwt"
    payload_available: "ON"
    payload_not_available: "OFF"
    qos: 1

Battery - Predicted Lifetime (seconds)

Topic: {prefix}/{domainName}/{machineName}/windows-monitor/stats/battery/full-lifetime
IOTLink Version: 1.1.1
Payload Type: Integer
Payload Example: 9999
Observation: There are several cases around the Internet that Windows API doesn't report it correctly depending on the device. It will show only '-1' always.

Home Assistant:

sensor:
  - platform: mqtt
    name: "My Computer - Predicted Lifetime"
    state_topic: "iotlink/workgroup/my-computer/windows-monitor/stats/battery/full-lifetime"
    unit_of_measurement: 'minutes'
    icon: mdi:timer
    value_template: "{{ ( value | float / 60 ) | int }}"
    availability_topic: "iotlink/workgroup/my-computer/lwt"
    payload_available: "ON"
    payload_not_available: "OFF"
    qos: 1

Hard Drives Sensors

Hard Drive - HDD Usage (%)

Topic: {prefix}/{domainName}/{machineName}/windows-monitor/stats/hard-drive/c/drive-usage
IOTLink Version: 1.1.1
Payload Type: Integer
Payload Example: 100

Home Assistant:

sensor:
  - platform: mqtt
    name: "My Computer - HDD Usage (C)"
    state_topic: "iotlink/workgroup/my-computer/windows-monitor/stats/hard-drive/c/drive-usage"
    unit_of_measurement: '%'
    icon: mdi:chart-donut
    value_template: "{{ value }}"
    availability_topic: "iotlink/workgroup/my-computer/lwt"
    payload_available: "ON"
    payload_not_available: "OFF"
    qos: 1

Hard Drive - HDD Total Size (MB)

Topic: {prefix}/{domainName}/{machineName}/windows-monitor/stats/hard-drive/c/total-size
IOTLink Version: 1.1.1
Payload Type: Integer
Payload Example: 999999

Home Assistant:

sensor:
  - platform: mqtt
    name: "My Computer - HDD Total Size (C)"
    state_topic: "iotlink/workgroup/my-computer/windows-monitor/stats/hard-drive/c/total-size"
    unit_of_measurement: 'MB'
    icon: mdi:harddisk
    value_template: "{{ value }}"
    availability_topic: "iotlink/workgroup/my-computer/lwt"
    payload_available: "ON"
    payload_not_available: "OFF"
    qos: 1

Hard Drive - HDD Total Free Space (MB)

Topic: {prefix}/{domainName}/{machineName}/windows-monitor/stats/hard-drive/c/total-free-space
IOTLink Version: 1.1.1
Payload Type: Integer
Payload Example: 999999

Home Assistant:

sensor:
  - platform: mqtt
    name: "My Computer - HDD Total Free Space (C)"
    state_topic: "iotlink/workgroup/my-computer/windows-monitor/stats/hard-drive/c/total-free-space"
    unit_of_measurement: 'MB'
    icon: mdi:harddisk
    value_template: "{{ value }}"
    availability_topic: "iotlink/workgroup/my-computer/lwt"
    payload_available: "ON"
    payload_not_available: "OFF"
    qos: 1

Hard Drive - HDD Free Space (MB)

Topic: {prefix}/{domainName}/{machineName}/windows-monitor/stats/hard-drive/c/available-free-space
IOTLink Version: 1.1.1
Payload Type: Integer
Payload Example: 999999

Home Assistant:

sensor:
  - platform: mqtt
    name: "My Computer - HDD Free Space (C)"
    state_topic: "iotlink/workgroup/my-computer/windows-monitor/stats/hard-drive/c/available-free-space"
    unit_of_measurement: 'MB'
    icon: mdi:harddisk
    value_template: "{{ value }}"
    availability_topic: "iotlink/workgroup/my-computer/lwt"
    payload_available: "ON"
    payload_not_available: "OFF"
    qos: 1

Hard Drive - HDD Used Space (MB)

Topic: {prefix}/{domainName}/{machineName}/windows-monitor/stats/hard-drive/c/used-space
IOTLink Version: 1.1.1
Payload Type: Integer
Payload Example: 999999

Home Assistant:

sensor:
  - platform: mqtt
    name: "My Computer - HDD Used Space (C)"
    state_topic: "iotlink/workgroup/my-computer/windows-monitor/stats/hard-drive/c/used-space"
    unit_of_measurement: 'MB'
    icon: mdi:harddisk
    value_template: "{{ value }}"
    availability_topic: "iotlink/workgroup/my-computer/lwt"
    payload_available: "ON"
    payload_not_available: "OFF"
    qos: 1

Hard Drive - HDD Format

Topic: {prefix}/{domainName}/{machineName}/windows-monitor/stats/hard-drive/c/drive-format
IOTLink Version: 1.1.1
Payload Type: String
Payload Example: NTFS

Home Assistant:

sensor:
  - platform: mqtt
    name: "My Computer - HDD Format (C)"
    state_topic: "iotlink/workgroup/my-computer/windows-monitor/stats/hard-drive/c/drive-format"
    unit_of_measurement: ''
    icon: mdi:harddisk
    value_template: "{{ value }}"
    availability_topic: "iotlink/workgroup/my-computer/lwt"
    payload_available: "ON"
    payload_not_available: "OFF"
    qos: 1

Hard Drive - HDD Label

Topic: {prefix}/{domainName}/{machineName}/windows-monitor/stats/hard-drive/c/volume-label
IOTLink Version: 1.1.1
Payload Type: String
Payload Example: NTFS

Home Assistant:

sensor:
  - platform: mqtt
    name: "My Computer - HDD Label (C)"
    state_topic: "iotlink/workgroup/my-computer/windows-monitor/stats/hard-drive/c/volume-label"
    unit_of_measurement: ''
    icon: mdi:harddisk
    value_template: "{{ value }}"
    availability_topic: "iotlink/workgroup/my-computer/lwt"
    payload_available: "ON"
    payload_not_available: "OFF"
    qos: 1

Network Sensors

Network - IPv4

Topic: {prefix}/{domainName}/{machineName}/windows-monitor/stats/network/0/ipv4
IOTLink Version: 1.2.0
Payload Type: String
Payload Example: 127.0.0.1

Home Assistant:

sensor:
  - platform: mqtt
    name: "ALEXANDRE PC - Network IPv4"
    state_topic: "iotlink/workgroup/my-computer/windows-monitor/stats/network/0/ipv4"
    unit_of_measurement: ''
    icon: mdi:lan
    value_template: "{{ value }}"
    availability_topic: "iotlink/workgroup/my-computer/lwt"
    payload_available: "ON"
    payload_not_available: "OFF"
    qos: 1

Network - IPv6

Topic: {prefix}/{domainName}/{machineName}/windows-monitor/stats/network/0/ipv6
IOTLink Version: 1.2.0
Payload Type: String
Payload Example: 2001:0db8:85a3::7344

Home Assistant:

sensor:
  - platform: mqtt
    name: "ALEXANDRE PC - Network IPv6"
    state_topic: "iotlink/workgroup/my-computer/windows-monitor/stats/network/0/ipv6"
    unit_of_measurement: ''
    icon: mdi:lan
    value_template: "{{ value }}"
    availability_topic: "iotlink/workgroup/my-computer/lwt"
    payload_available: "ON"
    payload_not_available: "OFF"
    qos: 1

Network - Port Speed (Mbps)

Topic: {prefix}/{domainName}/{machineName}/windows-monitor/stats/network/0/speed
IOTLink Version: 1.2.0
Payload Type: Integer
Payload Example: 1000

Home Assistant:

sensor:
  - platform: mqtt
    name: "ALEXANDRE PC - Network Speed"
    state_topic: "iotlink/workgroup/my-computer/windows-monitor/stats/network/0/speed"
    unit_of_measurement: 'Mbps'
    icon: mdi:speedometer
    value_template: "{{ value }}"
    availability_topic: "iotlink/workgroup/my-computer/lwt"
    payload_available: "ON"
    payload_not_available: "OFF"
    qos: 1

Network - Wired

Topic: {prefix}/{domainName}/{machineName}/windows-monitor/stats/network/0/wired
IOTLink Version: 1.2.0
Payload Type: Boolean
Payload Example: True/False

Home Assistant:

binary_sensor:
  - platform: mqtt
    name: "ALEXANDRE PC - Wired"
    state_topic: "iotlink/workgroup/my-computer/windows-monitor/stats/network/0/wired"
    unit_of_measurement: ''
    icon: mdi:ethernet
    value_template: "{{ value }}"
    availability_topic: "iotlink/workgroup/my-computer/lwt"
    payload_available: "ON"
    payload_not_available: "OFF"
    payload_on: "True"
    payload_off: "False"
    qos: 1

Display Sensors

Displays - Display 0
- Topic: {prefix}/{domainName}/{machineName}/windows-monitor/stats/display/0/screen
- IOTLink Version: 1.1.1
- Payload Type: Binary (PNG)
- Home Assistant:
```
camera:
  - platform: mqtt
    name: "My Computer - Screen 0"
    topic: "iotlink/workgroup/my-computer/windows-monitor/stats/display/0/screen"
```

Media Sensors

Media - Playing

Topic: {prefix}/{domainName}/{machineName}/windows-monitor/stats/media/playing
IOTLink Version: 1.3.0
Payload Type: Boolean
Payload Example: True/False

Home Assistant:

binary_sensor:
  - platform: mqtt
    name: "ALEXANDRE PC - Media Playing"
    state_topic: "iotlink/workgroup/my-computer/windows-monitor/stats/media/playing"
    icon: mdi:ethernet
    value_template: "{{ value }}"
    availability_topic: "iotlink/workgroup/my-computer/lwt"
    payload_available: "ON"
    payload_not_available: "OFF"
    payload_on: "True"
    payload_off: "False"
    qos: 1

Media - Muted

Topic: {prefix}/{domainName}/{machineName}/windows-monitor/stats/media/muted
IOTLink Version: 1.3.0
Payload Type: Boolean
Payload Example: True/False

Home Assistant:

binary_sensor:
  - platform: mqtt
    name: "ALEXANDRE PC - Media Muted"
    state_topic: "iotlink/workgroup/my-computer/windows-monitor/stats/media/muted"
    icon: mdi:ethernet
    value_template: "{{ value }}"
    availability_topic: "iotlink/workgroup/my-computer/lwt"
    payload_available: "ON"
    payload_not_available: "OFF"
    payload_on: "True"
    payload_off: "False"
    qos: 1

Media - Volume

Topic: {prefix}/{domainName}/{machineName}/windows-monitor/stats/media/volume
IOTLink Version: 1.3.0
Payload Type: Integer
Payload Example: 0-100

Home Assistant:

sensor:
  - platform: mqtt
    name: "ALEXANDRE PC - Media Volume"
    state_topic: "iotlink/workgroup/my-computer/windows-monitor/stats/media/volume"
    unit_of_measurement: '%'
    icon: mdi:speedometer
    value_template: "{{ value }}"
    availability_topic: "iotlink/workgroup/my-computer/lwt"
    payload_available: "ON"
    payload_not_available: "OFF"
    qos: 1

Observation

Remember that all topics will be prefixed with your configured prefix, domain and machine name.
On the above examples, the following variables are used to represent:
- {prefix}: Configured global topic prefix.
- {domainName}: Domain name which the host machine is currently configured.
- {machineName}: Machine name from the host machine.

Comments

Please register or sign in to add a comment.

Windows Monitor

Information

Publishing Topics

General Status

System Sensors

CPU Sensors

Memory Sensors

Battery Sensors

Hard Drives Sensors

Network Sensors

Display Sensors

Media Sensors

Observation

Comments