ZenSpace
  1. ring-light
ZenSpace
  • ZenSpace Integration Documentation
  • ZenSpace General Architecture - Overview
  • ZenSpace API V1.0
    • Device Management
      • lock
        • Get Device Status
        • Subscribe to Device Events
        • Action on IoT Device
        • Get Device Control
      • camera
        • Get Device Status
        • Subscribe to Device Events
        • Action on IoT Device
        • Get Device Instruction
        • Get Device Control
      • light
        • Get Device Instruction
        • Get Device Status
        • Subscribe to Device Events
        • Action on IoT Device
        • Get Device Control
      • fan
        • Get Device Status
        • Subscribe to Device Events
        • Action on IoT Device
        • Get Device Instruction
        • Get Device Control
      • o3-sensor
        • temprature
          • Subscribe to Device Events Copy Copy
          • Get Device Status
        • buzzer
          • Get Device Status Copy
          • Action on IoT Device
        • occupancy
          • Get Device Status
        • ring-light
          • Action on IoT Device
          • Get Device Status
        • Get Device Instruction
        • Get Device Status
        • Subscribe to Device Events
        • Action on IoT Device
        • Get Device Control
      • meeting-room-display
        • Get Device Status
      • Get Device Instruction Copy
      • Fetch Associated Device Types
    • Bookings
      • Create, Update, or Cancel a Booking
      • Bulk Booking Operation
      • Check-in Operation
    • Meeting Space
      • Store Meeting Space Availability
      • Get the list of meeting spaces.
      • Get the state of a specific meeting space.
  • ZenSpace API V2.0
    • Device Management
      • lock
        • Get Device Control
        • Action on IoT Device
        • Subscribe to Device Events
        • Get Device Status
      • camera
        • Subscribe to Device Events
        • Get Device Control
        • Get Device Instruction
        • Action on IoT Device
        • Get Device Status
      • light
        • Get Device Status
        • Subscribe to Device Events
        • Get Device Instruction
        • Get Device Control
        • Action on IoT Device
      • fan
        • Get Device Instruction
        • Get Device Control
        • Action on IoT Device
        • Subscribe to Device Events
        • Get Device Status
      • o3-sensor
        • temprature
          • Get Device Status
          • Subscribe to Device Events Copy Copy
        • buzzer
          • Action on IoT Device
          • Get Device Status Copy
        • occupancy
          • Get Device Status
        • ring-light
          • Get Device Status
            POST
          • Action on IoT Device
            POST
        • Action on IoT Device
          POST
        • Get Device Control
          POST
        • Subscribe to Device Events
          GET
        • Get Device Status
          POST
        • Get Device Instruction
          GET
      • meeting-room-display
        • Get Device Status
      • Fetch Associated Device Types
        GET
      • Get Device Instruction Copy
        GET
    • Bookings
      • Check-in Operation
      • Bulk Booking Operation
      • Create, Update, or Cancel a Booking
    • Meeting Space
      • Get the state of a specific meeting space.
      • Get the list of meeting spaces.
      • Store Meeting Space Availability
  • ZenSpace Supported Devices
    • ZenSpace Device Integration
  1. ring-light

Action on IoT Device

Developing
POST
/api/devices/{meeting_space_id}/action
Trigger an action on a specific IoT device based on its type.

Request

Path Params

Body Params application/json

Example
{
    "device_type": "o3-sensor",
    "parameters": {
        "sub_device": "ring-light",
        "action": "on/off/color/brightness",
        "value": "null/blue/0-10"
    }
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/devices//action' \
--header 'Content-Type: application/json' \
--data-raw '{
    "device_type": "o3-sensor",
    "parameters": {
        "sub_device": "ring-light",
        "action": "on/off/color/brightness",
        "value": "null/blue/0-10"
    }
}'

Responses

🟢200OK
application/json
Action triggered successfully.
Body

Example
{
    "status": "success",
    "response": "action performed successfully"
}
🟠400Bad Request
🟠404Record Not Found
🔴500Server Error
Modified at 2025-05-09 12:02:11
Previous
Get Device Status
Next
Action on IoT Device
Built with