curl --request PATCH \
  --url https://api.nox.energy/v1/devices/settings \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "user_id": "user456",
  "device_id": "device123",
  "room": {
    "temperature_lower_bound": 1.5,
    "temperature_upper_bound": 2,
    "preferred_temperature": 21,
    "schedule_enabled": true,
    "temperature_control_mode": "auto"
  },
  "dhw": {
    "temperature_lower_bound": 45,
    "temperature_upper_bound": 60
  },
  "optimization_settings": {
    "pv_self_consumption": false,
    "dynamic_tariff": false,
    "flex_trading": true,
    "imbalance_optimization": false
  },
  "location": {
    "country": "NL",
    "postal_code": "1234AB"
  }
}
'

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

User Management

Patch Devices Settings

Update on a device or nox user level the device/user settings. If you want to update a setting on a device level, only the device_id needs to be provided. Any of the settings can be updated separately or together.

You can change the following settings:

The lower and upper room comfort temperature bounds of end users/devices in degrees celcius.
The lower and upper bounds for domestic hot water heating in degrees celcius. This will determine the maximum and minimum allowed temperatures we allow it to go. This should be changed carefully as it could lead to the tank temperature going too low and cause legionella growth. Below 40 degrees is not recommended, only during vacations.
The preferred temperature of end users/devices in degrees celcius. This is also used to determine when to start cooling in temperature_control_mode auto or cooling mode.
Temperature control mode to determine if you only want heating or cooling or both (auto) or none of both (off). If auto is chosen, our system will decide if cooling is necessary based on outside temperature and upper comfort bounds. Off means we will turn room heating and cooling off and if this is not possible, we will configure the heat pump in a way so it will not cool or heat. If heating is chosen we will only heat and it will be based on the preferred temperature or the schedule and the comfort bounds. If cooling is chosen, we will only cool and it will be based on the preferred temperature or the schedule, outside temperature and the comfort bounds.
Enable/Disable steering optimizations. Flex_trading is mutually exclussive with the other optimizations. The other optimizations can be enabled together. If flex_trading is enabled, we disable all other optimizations. If any other optimization is enabled, we disable flex_trading. flex_trading means that the supplier steers the device based on a schedule they provide to NOX Energy. If you are a supplier that has a full-control package integration with Nox Energy, you should not enable flex_trading but instead the other optimization options like: imbalance_optimization to optimize the device to minimize imbalances based on the imbalance prices of the users country. dynamic_tariff means that we will optimize the device based on the day-ahead market prices of the users country. pv_self_consumption to optimize the device to maximize self-consumption of pv production for users that have pv panels.`
The country code and the postal code

PATCH

devices

settings

curl --request PATCH \
  --url https://api.nox.energy/v1/devices/settings \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "user_id": "user456",
  "device_id": "device123",
  "room": {
    "temperature_lower_bound": 1.5,
    "temperature_upper_bound": 2,
    "preferred_temperature": 21,
    "schedule_enabled": true,
    "temperature_control_mode": "auto"
  },
  "dhw": {
    "temperature_lower_bound": 45,
    "temperature_upper_bound": 60
  },
  "optimization_settings": {
    "pv_self_consumption": false,
    "dynamic_tariff": false,
    "flex_trading": true,
    "imbalance_optimization": false
  },
  "location": {
    "country": "NL",
    "postal_code": "1234AB"
  }
}
'

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

x-api-key

string

header

required

API Key authentication. Enter your API key in the format: YOUR_API_KEY

Body

application/json

device_id

string | null

Device ID to update settings for

user_id

string | null

User ID to update settings for

room

RoomSettings · object | null

Room temperature control settings

Show child attributes

dhw

DHWSettings · object | null

Domestic hot water settings

Show child attributes

optimization_settings

OptimizationSettings · object | null

Optimization settings for flex trading, dynamic tariff and PV self-consumption

Show child attributes

location

LocationSettings · object | null

Location-related settings

Show child attributes

Response

No Content - Settings updated successfully

API setup

Full NOX Control Package

Supplier Control Package

Manufacturer Package

Connecting Users and Devices

PV

Patch Devices Settings

Authorizations

Body

Response