hats

README

HATS

Home Assistant + NATS = HATS

I have been running this at home for over a year, but should be considered alpha software because breaking changes can occur at any time.

Features

• Push Home Assistant websocket events to a NATS message queue
• Caching proxy for Home Assistant API
• Generic implementations for subscribing to NATS topics
• Clients for some APIs (limited functionality)
  • Gokapi
  • ntfy
  • qBittorrent
  • Syncthing
  • National Weather Service
  • Amcrest Cameras
  • Infisical

NATS Topics

• homeassistant.states.{domain}.{entity}.{state} - Home Assistant device state changes: payload
• homeassistant.attributes.{domain}.{entity}.{state} - When a device's attributes change but the state hasn't changed: payload
• homeassistant.zha.{device IEEE} - ZHA events: payload
• homeassistant.zwave-scene.{device ID} - ZwaveJS scene events: payload
• homeassistant.nfc.{tag ID} - Home Assistant NFC tag scanned: payload
• homeassistant.timer.{timer name}.finished - Home Assistant timer finished: payload is simply "finished"
• schedules.{schedule name} - HATS schedule finished: payload is simply "finished"
• command.{command name} - Command called via HATS API: payload is a byte array of the HTTP Post body

Examples (work in progress)

See the example directory for an example Docker Compose and client implementation.