Skip to main content

A simple Python SDK for the Netatmo Energy API (thermostats).

Project description

netatmo-energy

Setup

  1. Create an app at dev.netatmo.com to get your API credentials
  2. Either create a .env file:
CLIENT_ID=your_client_id
CLIENT_SECRET=your_client_secret
ACCESS_TOKEN=your_access_token
REFRESH_TOKEN=your_refresh_token

of pass in the vars to Thermostat(client_id, client_secret, access_token, refresh_token) when initializing the API client.

Usage

t = Thermostat()
hd = t.homesdata()
home_id = hd.homes[0].id
room_id = hd.homes[0].rooms[0].id

# Get current status
t.room_temperatures(home_id)
[{'room_id': '3352988001',
  'temperature': 21.7,
  'setpoint': 21.5,
  'setpoint_mode': 'manual'}]
# Set room to 20°C for 1 hour
t.setroomthermpoint(home_id, room_id, mode='manual', temp=21, endtime=int(time())+3600)
{'status': 'ok', 'time_server': 1767753063}
t.room_temperatures(home_id)
[{'room_id': '3352988001',
  'temperature': 21.7,
  'setpoint': 21,
  'setpoint_mode': 'manual'}]
# Get temperature history
r = t.getroommeasure(home_id, room_id)[0]
list(r), r['value'][:3]
(['beg_time', 'step_time', 'value'], [[22.2], [22.2], [22.1]])

Methods

  • homesdata() — get homes and topology
  • homestatus(home_id) — current device status
  • room_temperatures(home_id) — quick view of all room temps
  • getroommeasure(home_id, room_id, ...) — temperature history
  • setroomthermpoint(home_id, room_id, mode, ...) — set room temperature
  • setthermmode(home_id, mode) — set home mode (schedule/away/hg)
  • getmeasure(device_id, ...) — boiler history
  • createnewhomeschedule(...) — create weekly schedule
  • synchomeschedule(...) — modify schedule
  • switchhomeschedule(home_id, schedule_id) — activate schedule

Thermostat Widget

The library includes a ready-to-use FastHTML/MonsterUI thermostat widget for building web dashboards. Use setup_thermostat_widget() to register the routes and get the widget component:

app, rt = fast_app()
t = Thermostat()

# Get your home and room IDs
homes = t.homesdata()
home_id = homes.homes[0].id
room_id = homes.homes[0].rooms[0].id

# Setup widget (registers /setpoint route and returns the component)
climate_widget = setup_thermostat_widget(rt, t, home_id, room_id)

@rt("/")
def get():
    return climate_widget

Thermostat Widget

The widget displays current temperature, target setpoint with +/- controls, and a temperature history chart. Clicking the controls makes HTMX requests to adjust the thermostat in real-time.

Note: the widget uses MonsterUI’s ApexCharts so you will have to include this in your headers Theme.blue.headers(apex_charts=True)

Dashboard

The main.py file includes a fully functional dashboard app with Google OAuth authentication, ready to be deployed. The solar energy widget is a placeholder—only the climate/thermostat functionality is connected to the Netatmo API.

Deployment was done using pla.sh and is documented in the nbs/00_core.ipynb notebook.

Dashboard

The house thumbnail was generated by copy-pasting a Google Maps screenshot into Gemini Nano Banana with this prompt:

Present a clear, 45° top-down isometric miniature 3D cartoon scene of [LOCATION], featuring its most iconic landmarks and architectural elements. Use soft, refined textures with realistic PBR materials and gentle, lifelike lighting and shadows. Integrate the current weather conditions directly into the city environment to create an immersive atmospheric mood. Use a clean, minimalistic composition with a soft, solid-colored background.

Background

Inspired by Andrej Karpathy’s tweet about using Claude Code for home automation. Instead of burning tokens on network scanning, this takes the “boring” approach: read the docs, write a simple SDK.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

netatmo_thermostat-0.0.4.tar.gz (23.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

netatmo_thermostat-0.0.4-py3-none-any.whl (21.5 kB view details)

Uploaded Python 3

File details

Details for the file netatmo_thermostat-0.0.4.tar.gz.

File metadata

  • Download URL: netatmo_thermostat-0.0.4.tar.gz
  • Upload date:
  • Size: 23.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for netatmo_thermostat-0.0.4.tar.gz
Algorithm Hash digest
SHA256 5013a69701d64e7ab8b114404e98227e33c0529cd4394ed8a7bf2a6c7b386554
MD5 172fb11f73ef0d0f14eb78f152bc42b5
BLAKE2b-256 f78619c97b4c65b030cebc9437e787c42c349d702909fa0998a23e1509fb02d5

See more details on using hashes here.

File details

Details for the file netatmo_thermostat-0.0.4-py3-none-any.whl.

File metadata

File hashes

Hashes for netatmo_thermostat-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 769cdb0653643bc5a41adb4814c5e8edd3e2125190011c7df1eff391b8cdb903
MD5 c19cad85d7d4234ec3ed028fe6eeef95
BLAKE2b-256 95d5cbaf1560feedde9831c4cc39ef856ec9fd4f77551e826479e3ef5d97fb2b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page