API requests

Supported API requests

The adapter supports all existing API requests from the Netatmo Energy API. Some of them will be called automatically during the adapter process. Some of them are only supported to execute it manually. If you use the request manually, you can define optional parameters. These are placed in the request folder of each available API request.

GET-API Requests

• homesdata

  • Get the whole structure of your Netatmo energy environment and create the objects in the root directory of the adapter. The request will be executed by using the parameter NAPlug.

• homestatus

  • Get the status and the technical information's of your valves assigned in your rooms. This information's will be placed in the assigned room during this process.

• getroommeasure

  • Retrieve data history of a room. The response of this request will be stored in the "response" field.

• getmeasure

  • Retrieve boiler historical data. The response of this request will be stored in the "response" field.

SET-API Requests

• setroomthermpoint

  • Sets the temperature of the desired room. This request will be executed automatically (depending on adapter settings), or it will be executed by using the "trigger" option (see below)

• setthermmode

  • setthermmode_schedule
    • Set the mode of your Netatmo Energy to schedule (default mode in Netatmo Cloud)
  • setthermmode_hq
    • Set the mode of your Netatmo Energy to hq (freeze mode)
  • setthermmode_away
    • Set the mode of your Netatmo Energy to away (away from home)

• switchhomeschedule

  • Set the schedule mode of all available schedule types. All possible combinations of the API request and its parameters are listed in channel switchhomeschedule as separate API requests. The possible setting are depends on your Netatmo Cloud settings.

• synchomeschedule

  • Set the thermostat schedule of a home. To edit a particular schedule, you need to enter the schedule_id, if you don't specify one, the modification will be applied to the current schedule. Please specify the necessary parameters and send the request using synchomeschedule.

• createnewhomeschedule

  • Creates a new thermostat schedule for a home. Please specify the necessary parameters and send the request using createnewhomeschedule.

If an API request need Parameters, you can find these in the channel "parameters" in the corresponding API request channel.

Trigger

• applychanges
  • Transfer all manual changes of your valves to Netatmo Energy
    • Therefore you have to set the "SetTemp" datapoint and in the adapter configuration you have to disable the option "apply temperature immediately"
• refresh_structure
  • Create request homesdata and homestatus in sequence to refresh the whole Netatmo homes structure

Update requests

• setroomthermpoint ... depending on the "setting" channel, it sets the temperature of each room (immediately or by using the trigger "applychanges").
• set_mode_to_home ... In the channel "setting" you can use the button "set_mode_to_home" to set "home"-Mode for the valve.

Messages

• message_text ... all messages are transferred to this datapoint

Status

• running
  • Here you can see if an API Requests is running at the moment. You can use this information's to trigger foreign processes.

Request structure