[Plugin] Home Assistant Bridge

[belgianfred2]

Home Assistant Bridge – GOverlay plugin

Bring any Home Assistant entity onto your GOverlay display: NAS disks, temperatures, power usage, lights, switches, media players and more.

Features

• Reads all entities through the Home Assistant REST API
• Sensors are created automatically: no need to type entity names, they use Home Assistant's friendly names and units
• Each sensor is sorted into the matching GOverlay category: Storage, CPU, GPU, Memory, Network, Power, Time, Audio, Motherboard (temperatures), everything else in Other
• Optional filter to keep only some entities (e.g. mynas or sensor.)
• Adjustable refresh interval (default 10 s) and number of decimals (default 2)
• Two status sensors: connection state and time of last update
• Network requests run in the background, so GOverlay never waits on Home Assistant

Requirements

• GOverlay Plus on Windows
• A Home Assistant instance reachable from the PC
• A long-lived access token (Home Assistant: your profile → Security → Long-lived access tokens → Create token)

Installation

1. Copy HomeAssistantBridge.dll into the GOverlay Plugins folder
2. Restart GOverlay
3. Enable Home Assistant Bridge and enter your Home Assistant address (e.g. http://192.168.1.50:8123) and your token in its options

Sensors use the HAB prefix.
Notes: the option labels are currently in French. If you have many entities, use the filter to keep the sensor list manageable. Restart GOverlay after changing the filter.

Source code (C#, .NET Framework 4.5.2) is included.

[TheLaGmAn]

thank you very much for creating the plugin and sharing it with the community!

I was recently implementing HA as well on a plugin not yet released and was adding additional hardwaretypes and hardware units since we are a bit short on those.

It will be

Code: Select all


    Structure HardwareTypes
        Const OTHER = 0
        Const CPU = 1
        Const GPU = 2
        Const STORAGE = 3
        Const IO = 4
        Const MEMORY = 5
        Const MOTHERBOARD = 6
        Const POWER = 7
        Const TIME = 8
        Const GAME = 9
        Const AUDIO = 10

        Const WEATHER = 11
        Const DOOR = 12
        Const WINDOW = 13
        Const VACUUM = 14
        Const MOWER = 15
        Const CURTAIN = 16
        Const CLIMATE = 17
        Const LIGHT = 18
        Const FAN = 19
        Const HUMIDIFIER = 20
        Const HEATER = 21
        Const LOCK = 22
        Const VALVE = 23
        Const CAMERA = 24
        Const ALARM = 25
        Const TRACKER = 26
        Const SWITCH = 27
        Const SENSOR = 28
        Const MEDIA_PLAYER = 29

    End Structure

    Structure UnitTypes
        Const TEMPERATURE_C = 1
        Const TEMPERATURE_F = 2
        Const AMPERS = 3
        Const RPM = 4
        Const VOLTAGE = 5
        Const MEGAHERTZ = 6
        Const WATTS = 7
        Const SPEED_PERC = 8
        Const LEVEL_PERC = 9
        Const LOAD_PERC = 10
        Const Bytes = 11
        Const Kilobytes = 12
        Const Megabytes = 13
        Const Gigabytes = 14
        Const Terabytes = 15
        Const Time = 16

        Const Other = 0

        Const Kilowatts = 17
        Const WattHours = 18
        Const KilowattHours = 19
        Const Hertz = 20
        Const KiloHertz = 21
        Const Pascals = 22
        Const HectoPascals = 23
        Const KiloPascals = 24
        Const BAR = 25
        Const PSI = 26
        Const LUX = 27
        Const PPM = 28
        Const PPB = 29
        Const Decibels = 30
        Const Dbm = 31
        Const Milliseconds = 32
        Const Seconds = 33
        Const Minutes = 34
        Const Hours = 35
        Const Days = 36
        Const Dates = 37
        Const Millimeters = 38
        Const Centimeters = 39
        Const Meters = 40
        Const Miles = 41
        Const Yards = 42
        Const Kilometers = 43

        Const MPS = 44
        Const KPH = 45
        Const MPH = 46
        Const Liters = 47
        Const CubicMeters = 48
        Const CubicCentimeters = 49

        Const Grams = 50
        Const Kilograms = 51
        Const Pounds = 52

        Const BitsPerSecond = 53
        Const KiloBitsPerSecond = 54
        Const MegabitsPerSecond = 55
        Const GigabitsPerSecond = 56
        Const BytesPerSecond = 57
        Const KiloBytesPerSecond = 58
        Const MegabytesPerSecond = 59
        Const GigabytesPerSecond = 60

        Const Switch = 61


    End Structure

You cant use them yet but if you dont mind adding those to you plugin when i release the new interfaces with support for it, it will be great.

[belgianfred2]

Hi @TheLaGmAn,

Thank you for the kind words, and for sharing the new hardware and unit types in advance!

I have already added them to Home Assistant Bridge. Since the current interfaces do not support them yet, they sit behind a new plugin option, "Extended categories and units" (Yes/No), which is set to No by default. With No, the plugin behaves exactly as before. Once your new version is out, users only need to switch it to Yes, without updating the plugin.

With the option enabled:

• Hardware types: Home Assistant domains map to the new types (light → LIGHT, climate → CLIMATE, switch / input_boolean → SWITCH, cover → CURTAIN / DOOR / WINDOW depending on its device class, weather, vacuum, lawn_mower, lock, valve, camera, alarm_control_panel, device_tracker / person → TRACKER, media_player → MEDIA_PLAYER…). Door, window and smoke / gas binary sensors go to DOOR, WINDOW and ALARM.
• Hardware entities (NAS, PC…) keep the existing types (CPU, STORAGE, MEMORY, IO, POWER, TIME). All other sensors go to SENSOR.
• Unit types: Home Assistant units are converted to the matching UnitTypes value (°C, W, kWh, hPa, lx, ppm, dBm, GiB, kB/s, km/h…). Percentages use LOAD_PERC, SPEED_PERC or LEVEL_PERC depending on the entity. On/off entities use Switch.

Two questions for when you release it:

• Sensor names currently include the unit, e.g. "Volume 2 Used space (TB)". If GOverlay displays the unit itself when unit is set, I will remove it from the name to avoid showing it twice.
• I used the values exactly as you posted them. Please let me know if any of them change before the release.

I also added Windows notifications to the plugin: up to 5 rules (e.g. notify when a headset battery goes from 2 to 1, or when a door opens), each with an optional custom message. GOverlay Plus then forwards them to the display like any other Windows notification.

Thanks again for GOverlay!

[belgianfred2]

Home Assistant Bridge – Update

A new version of Home Assistant Bridge is available. Here is what changed since the first release.

What's new

• Windows notifications: up to 5 notifications, each with its own rule and custom message. Get notified when an entity reaches a value you choose (headset battery low, door opened...). GOverlay Plus forwards them to the display like any other Windows notification. See Notifications below.
• Ready for the upcoming GOverlay categories and units: new option "Extended categories and units". Once a GOverlay version supporting them is released, switch it to Yes and your entities will use the new categories (LIGHT, CLIMATE, SWITCH, DOOR, WINDOW, WEATHER, TRACKER, MEDIA_PLAYER...) and units (kWh, hPa, lx, km/h, dBm...). Leave it on No until then.
• Options in a logical order: address and token first, then filter, refresh interval and decimals, then the notification fields in pairs (rule, then message).
• Built-in help: the plugin description in GOverlay now explains what the plugin does and how to set it up.
• Logs: every notification sent is written to the GOverlay logs with its text, to help you check your rules.

Update
Replace HomeAssistantBridge.dll in the GOverlay Plugins folder and restart GOverlay. Your address, token and other settings are kept.

SETUP
Home Assistant address: the address you use to open Home Assistant in your browser, for example http://192.168.1.50:8123

Token: in Home Assistant, click your user name (bottom left) > Security tab > Long-lived access tokens > Create token. Copy it into the token field.

Other options

• Filter: leave empty to get all entities, or enter words separated by commas to keep only matching entities (e.g. mynas, sensor.). If you have many entities, a filter keeps the sensor list manageable. Restart GOverlay after changing the filter.
• Refresh interval: in seconds (minimum 2).
• Decimals: number of decimals for numeric values. Leave empty to show raw values.
• Extended categories and units: leave on No for now. Switch it to Yes only once a GOverlay version supporting the new categories and units is released.

NOTIFICATIONS (optional, up to 5)
The plugin can show a Windows notification when an entity changes to a value you choose. GOverlay Plus forwards it to the display like any other Windows notification.

"Rule" field:

1. In Home Assistant, open Developer tools > States.
2. Find your entity. Copy its ID from the "Entity" column, for example: sensor.headset_battery
3. Look at the "State" column to see its values, for example 2, on, off, home.
4. Write the ID, then =, then the value that triggers the notification.

Code: Select all

sensor.headset_battery=1

-> notification when the battery becomes 1.

Code: Select all

sensor.headset_battery=2>1

-> notification only when the battery goes from 2 to 1.

Code: Select all

binary_sensor.front_door=on

-> notification when the door opens (state becomes on).

Code: Select all

sensor.headset_battery

-> notification at every change.

"Message" field (optional): the text of the notification. If empty, it shows the entity name with the old and new values.

You can insert:

• {name} = the entity name
• {before} = the old value
• {after} = the new value

Example:

Code: Select all

{name} is at {after}, charge it!

Notes: no notification is sent when GOverlay starts, or when an entity becomes unavailable and comes back. Notifications also work for entities excluded by the filter.

Notes

• Some option labels are currently in French: "Adresse de Home Assistant" = address, "Jeton d'accès longue durée" = token, "Filtre" = filter, "Intervalle de mise à jour" = refresh interval, "Décimales" = decimals, "Catégories et unités étendues" = extended categories and units.
• Your token and address are stored in GOverlay's own configuration, never in the plugin file. Do not share screenshots of the options panel without hiding the token.

[TheLaGmAn]

Im attaching the interfaces that will go into the next version and has the additional hwtypes and units, its the same ones i posted before.
Two things:

1- check that your CURRENT plugin DLL works with this interface AND the old one without re-compiling, it should work with both, but just in case.
2- you can use GOverlayPlugin.Interfaces.IHost.AccessHost("version") in your plugin and it will return Nothing on the previous interfaces.dll and the current version on the new interfaces.dll, so you can use it as if it returned nothing, you dont have the new codes, if you do, you have them (but this will work when i release the new goverlay version, right now since its just the interfaces, it will be always nothing on the return). I will give you soon to test the full goverlay version if this works alright, but i want to make sure your plugin doesnt break between the current/new version.
Either way, the goverlay web version supports receiving them on any version, its just the desktop app not showing those codes correctly if you are using them.

[belgianfred2]

Hello,

Thank you, I confirm this break nothing. All is ok whe tested,

I could add an "Auto" setting to the "Extended categories and units" option and make it the default.
In Auto mode, the plugin would query GOverlay at startup: if it receives a version, it uses the new categories; otherwise, it uses the old ones. "Yes" and "No" would remain available to force one or the other.
The call would be protected so that any potential error would never break the plugin.