ZenSpace
  1. ZenSpace API V2.0
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
          • Action on IoT Device
        • Action on IoT Device
        • Get Device Control
        • Subscribe to Device Events
        • Get Device Status
        • Get Device Instruction
      • meeting-room-display
        • Get Device Status
      • Fetch Associated Device Types
      • Get Device Instruction Copy
    • 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. ZenSpace API V2.0

Device Management

This document outlines the core functionalities and features of the Device Management API, designed to control and monitor devices efficiently, ensuring a seamless user experience and robust automation capabilities.

1. Device Actions#

Device Actions allow users to perform real-time operations on connected devices, enabling comprehensive control over functionality. Examples include:
Lock/Unlock Devices: Secure or grant access to devices like doors, lockers, or safes.
Power Control: Turn devices on or off, such as lights, fans, or appliances.
Adjustable Settings:
Brightness: Control the intensity of lights.
Speed: Adjust the speed of fans or motors.
Color: Change the color of RGB-enabled devices.
These actions provide users with flexible and granular control over their devices.

2. Device Readings#

Device Readings focus on retrieving real-time data from sensors and devices to monitor and analyze environmental and operational metrics. Examples include:
Temperature Monitoring: Fetch real-time temperature readings from sensors.
Occupancy Detection: Track the presence of individuals in a room or space.
Lock Feedback: Verify the current state of locks (locked/unlocked).
These readings provide critical insights for decision-making and automation.

3. Device Events#

Device Events enable users to define and manage event-driven actions triggered by specific conditions. This feature supports:
Threshold-Based Triggers:
Temperature thresholds: Trigger actions like cooling or heating when a specific temperature is reached.
Occupancy-based triggers: Automatically turn on lights or enable devices when motion is detected.
Event Logging: Record all events for audit and monitoring purposes.
This feature ensures automated responses to changing conditions, improving efficiency and user experience.

4. Notifications#

The system provides automated notifications to ensure timely communication and response. Notifications can be sent via:
Email: Inform maintenance, security, or admin staff about device or system status.
SMS: Deliver critical alerts for immediate action.
Examples include:
Sending alerts when a device malfunctions or exceeds a threshold.
Notifying staff of scheduled maintenance or security breaches.
This ensures proactive maintenance and security management.

5. Meeting Space Control#

Meeting Space Control enables efficient management of meeting spaces based on conditions or user requirements. Key functionalities include:
Enable/Disable Meeting Spaces: Allow or restrict access to meeting spaces based on availability or operational status.
Condition-Based Management: Automatically control meeting space devices (e.g., lights, HVAC systems) based on occupancy or booking schedules.
Space Grouping: Group meeting spaces by area or type for easier management and reporting.
This feature enhances the utilization and operational efficiency of meeting spaces.

Summary#

The Device Management System is designed to provide robust control, monitoring, and automation capabilities. By integrating real-time actions, sensor readings, event management, notifications, and meeting space control, it empowers users to optimize their environments and operations effectively.
For further details, please contact the development team.
Modified at 2025-05-09 12:02:20
Previous
ZenSpace API V2.0
Next
lock
Built with