Heatmiser neoHub v3 API client (websocket/token aware)

5 unstable releases

0.3.1 Feb 18, 2023
0.3.0 Oct 4, 2022
0.2.1 Sep 24, 2022
0.2.0 Sep 24, 2022
0.1.0 Sep 23, 2022

#844 in Hardware support

21 downloads per month


433 lines

Heatmiser neohub "v3" (websocket/token) client

A (currently) low-level wrapper for the neoHub websocket API.

Upstream docs are available, with a free account, from https://dev.heatmiser.com/. They are not very complete or accurate.


All certificate information is ignored. The hub does not have a valid cert, and the client is set up to accept this. You must not trust data transmitted over an untrusted network.


Find your hub's address. Supposedly they respond to broadcast, but mine won't:

echo -n "hubseek" | nc -b -u 19790

I pulled the IP from my router's dashboard. Let's say the IP is

Next, create a token in the mobile app. The name doesn't matter. It looks like a uuidv4.

Export both of these as environment variables:

export NEOHUB_URL=wss://
export NEOHUB_TOKEN=69696969-6969-4969-6969-696969696969

Then, you can use the library:

let mut client = Client::from_env()?;
let result: Value = client.command_void(commands::GET_LIVE_DATA).await?;
println!("{}", result.to_string()));

Or one of the examples:

cargo run --example neohub-cli
  "COOL_INPUT": false,
  "HUB_AWAY": false,
  "HUB_HOLIDAY": false,


  • dump-live-data continually exports the GET_LIVE_DATA to zstd'd jsonlines files.

Contributing / Future

I don't think the API is stable enough to provide structs, like the (generated) LiveData struct, so I don't think adding those to the crate's API is a good idea.

Github issues or PRs, please.


MIT OR Apache-2.0


~371K SLoC