View on GitHub

DeskUp Pro

Control standing desks from your smart home system (Home Assistant and others) with DeskUp Pro

Using the Rest API

Using the api is fairly simple as long as your using a Smart Home hub that sends local (on your house network) rest api calls.

Smart home hubs that should be able to send local Rest Api requests are:

Then you can make a call to the api endpoints using http e.g.

http://192.168.68.120/<api-endpoint>

NOTE: As of ESPHome 2026.8.0 the api format is changing from using entity id to entity name, for example: from /sensor/desk_height to /sensor/Desk Height. Both formats will work until then. Also note the new format is case sensitive. The old and new formats are listed below but it is advised to switch to the new format before 2026.8.0. See https://esphome.io/web-api/index.html

List of Api endpoints

Sensors

Buttons

Number Controls

Cover Control

Light Controls

Sensor Controls

Get Desk Height

Old Format: GET http://<ipnumberhere>/sensor/desk_height
New Format: GET http://<ipnumberhere>/sensor/Desk Height

Response

{
  "name_id": "sensor/Desk Height",
  "id": "sensor-desk_height",
  "value": 102,
  "state": "102.0 cm"
}

Get Desk Height Percentage

Old Format: GET http://<ipnumberhere>/sensor/desk_height_percent
New Format: GET http://<ipnumberhere>/sensor/Desk Height Percent

Response

{
  "name_id": "sensor/Desk Height Percent",
  "id": "sensor-desk_height_percent",
  "value": 62.5,
  "state": "62.5 %"
}

Get preset button M1, M2, M3, M4 height value from the desk

Old Format: GET http://<ipnumberhere>/sensor/desk_m1_height
New Format: GET http://<ipnumberhere>/sensor/Desk M1 Height

Changing m1 to m2, m3 or m4 for the other memory presets.

Response

{
  "name_id": "sensor/Desk M1 Height",
  "id": "sensor-desk_m1_height",
  "value": 70,
  "state": "70.0 cm"
}

Get desk idle time in secconds

Old Format: GET http://<ipnumberhere>/sensor/idle_time
New Format: GET http://<ipnumberhere>/sensor/Idle Time

Response

{
  "name_id": "sensor/Idle Time",
  "id": "sensor-idle_time",
  "value": 7095,
  "state": "7095.0 s"
}

Get desk idle timestamp in days, hh:mm:ss

Old Format: GET http://<ipnumberhere>/sensor/idle_timestamp
New Format: GET http://<ipnumberhere>/sensor/Idle Timestamp

Response

{
  "name_id": "text_sensor/Idle Timestamp",
  "id": "text_sensor-idle_timestamp",
  "value": "02:07:50",
  "state": "02:07:50"
}

Get desk Status

Old Format: GET http://<ipnumberhere>/text_sensor/desk_status
New Format: GET http://<ipnumberhere>/text_sensor/Desk Status

Response

{
  "name_id": "text_sensor/Desk Status",
  "id": "text_sensor-desk_status",
  "value": "Idle",
  "state": "Idle"
}

Button Controls

Move the desk to the specified height

Old Format: POST http://<ipnumberhere>/number/desk_height/set?value=80
New Format: POST http://<ipnumberhere>/number/Desk Height/set?value=80

Response

No data returned just a 200 OK status

Press preset button M1, M2, M3, M4 on the desk

Old Format: POST http://<ipnumberhere>/button/desk_m1/press
New Format: POST http://<ipnumberhere>/button/Desk M1/press

Changing m1 to m2, m3 or m4 for the other memory presets.

Response

No data returned just a 200 OK status

Press Nudge Down button on the desk

Old Format: POST http://<ipnumberhere>/button/desk_nudge_down/press
New Format: POST http://<ipnumberhere>/button/Desk Nudge Down/press

Response

No data returned just a 200 OK status

Press Nudge Up button on the desk

Old Format: POST http://<ipnumberhere>/button/desk_nudge_up/press
New Format: POST http://<ipnumberhere>/button/Desk Nudge Up/press

Response

No data returned just a 200 OK status

Stop the desk moving

Old Format: POST http://<ipnumberhere>/button/desk_stop/press
New Format: POST http://<ipnumberhere>/button/Desk Stop/press

Response

No data returned just a 200 OK status

Press Desk Memory Preset Buttons M1, M2, M3, M4

Old Format: POST http://<ipnumberhere>/button/set_desk_m1/press
New Format: POST http://<ipnumberhere>/button/Set Desk M1/press

Changing m1 to m2, m3 or m4 for the other memory presets.

Response

No data returned just a 200 OK status

Restart the ESP32 device

Old Format: POST http://<ipnumberhere>/button/esp32_restart/press
New Format: POST http://<ipnumberhere>/button/ESP32 Restart/press

Response

No data returned just a 200 OK status

Number Controls

Get Desk Height

Old Format: GET http://<ipnumberhere>/number/desk_height
New Format: GET http://<ipnumberhere>/number/Desk Height

Response

{
  "name_id": "number/Desk Height",
  "id": "number-desk_height",
  "value": "102.0",
  "state": "102.0 cm"
}

Get Desk Min Height (as specified in configuration field)

Old Format: GET http://<ipnumberhere>/number/min_height
New Format: GET http://<ipnumberhere>/number/Min Height

Response

{
  "name_id": "number/Min Height",
  "id": "number-min_height",
  "value": "62.00",
  "state": "62.00 cm"
}

Set Desk Min Height (in configuration field)

Old Format: POST http://<ipnumberhere>/number/min_height/set?value=74
New Format: POST http://<ipnumberhere>/number/Min Height/set?value=74

Response

No data returned just a 200 OK status

Get Desk Max Height (as specified in configuration field)

Old Format: GET http://<ipnumberhere>/number/max_height
New Format: GET http://<ipnumberhere>/number/Max Height

Response

{
  "name_id": "number/Max Height",
  "id": "number-max_height",
  "value": "126.00",
  "state": "126.00 cm"
}

Set Desk Max Height (in configuration field)

Old Format: POST http://<ipnumberhere>/number/max_height/set?value=126
New Format: POST http://<ipnumberhere>/number/Max Height/set?value=126

Response

No data returned just a 200 OK status

Get Desk Down Offset by value (in mm)

Old Format: GET http://<ipnumberhere>/number/offset_down_by
New Format: GET http://<ipnumberhere>/number/Offset Down by

Response

{
  "name_id": "number/Offset Down by",
  "id": "number-offset_down_by",
  "value": "0",
  "state": "0 mm"
}

Set Desk Down Offset by value (in mm)

Old Format: POST http://<ipnumberhere>/number/offset_down_by/set?value=0
New Format: POST http://<ipnumberhere>/number/Offset Down by/set?value=0

Response

No data returned just a 200 OK status

Get Desk Up Offset by value (in mm)

Old Format: GET http://<ipnumberhere>/number/offset_up_by
New Format: GET http://<ipnumberhere>/number/Offset Up by

Response

{
  "name_id": "number/Offset Up by",
  "id": "number-offset_up_by",
  "value": "1",
  "state": "1 mm"
}

Set Desk Up Offset by value (in mm)

Old Format: POST http://<ipnumberhere>/number/offset_up_by/set?value=1
New Format: POST http://<ipnumberhere>/number/Offset Up by/set?value=1

Response

No data returned just a 200 OK status

Cover Control

Get Cover details

Old Format: GET http://<ipnumberhere>/cover/height_slider
New Format: GET http://<ipnumberhere>/cover/Height Slider

Response

{
  "name_id": "cover/Height Slider",
  "id": "cover-height_slider",
  "value": 0.18,
  "state": "OPEN",
  "current_operation": "IDLE",
  "position": 0.18
}

Set Cover Position

Old Format: POST http://<ipnumberhere>/cover/height_slider/set?position=0.1
New Format: POST http://<ipnumberhere>/cover/Height Slider/set?position=0.1

Allowed values 0.0 to 1.0

Response

No data returned just a 200 OK status

Light Control (S3 Chips only support the LED)

Get ESP32 Led Details

Old Format: GET http://<ipnumberhere>/light/esp32_led
New Format: GET http://<ipnumberhere>/light/ESP32 LED

Response

{
  "name_id": "light/ESP32 LED",
  "id": "light-esp32_led",
  "state": "OFF",
  "color_mode": "rgb",
  "brightness": 255,
  "color": {
    "r": 255,
    "g": 255,
    "b": 255
  }
}

Turn on the ESP32 Led and set the colour

Old Format: POST http://<ipnumberhere>/light/esp32_led/turn_on?r=25&g=25&b=125
New Format: POST http://<ipnumberhere>/light/ESP32 LED/turn_on?r=25&g=25&b=125

For more info view this page.

Response

No data returned just a 200 OK status

Turn off the ESP32 Led

Old Format: POST http://<ipnumberhere>/light/esp32_led/turn_off
New Format: POST http://<ipnumberhere>/light/ESP32 LED/turn_off

Response

No data returned just a 200 OK status