Home Assistant
OSRS sensors and automations in Home Assistant with the OSRS Data integration.
OSRS Data (ha-osrs-data) is a Home Assistant
integration for the same HA Exporter RuneLite plugin the hub uses. It gives you per-account sensors
(stats, inventory, equipment, health, prayer, location, spellbook), Home Assistant events for
automations, blueprints and a "Player Progress" dashboard.
It doesn't read from the hub yet
Today, OSRS Data pairs directly with RuneLite: the plugin sends to Home Assistant and to the hub separately, as two connections. A "hub mode", where Home Assistant reads everything from the hub's API instead, is planned. Until then, you don't need the hub for Home Assistant, and the hub doesn't need Home Assistant.
Install
- In HACS, open Custom repositories and add
https://github.com/RedFirebreak/ha-osrs-datawith category Integration. - Install OSRS Data and restart Home Assistant.
Pair RuneLite with Home Assistant
- In Home Assistant, go to Settings → Devices & services → Add integration and pick OSRS Data.
- Enter a name. A pairing code appears.
- In the HA Exporter panel in RuneLite, enter that code and your Home Assistant URL, and press Submit.
To pair another RuneLite client later, open the integration's options and pick Pair a new RuneLite client.
With the hub later
When hub mode lands, one key replaces pairing every client with Home Assistant. It will:
- poll
/snapshotevery 2–10 seconds withIf-None-Matchfor sensors (online, world, HP, prayer, skills, location); - follow
/events?cursor=to fire Home Assistant events.
The suggested key has the categories stats, events and activity, plus location_live for
coordinates. You can already build this yourself: see Build your own.