1-Gateways and Sensors with Ecobook platform


TABLE OF CONTENTS


1-Gateways and Sensors with Ecobook platform


Description

Ecobook is a smart workspace management platform developed by Skynapse Business Technology Pte Ltd, based in Singapore. It aims to help organizations optimize resource allocation for meeting rooms, workstations, and visitor management. Since its inception in 2008, Ecobook has evolved from a simple web-based application into an enterprise-grade solution, widely used in corporations, educational institutions, community centers, and co-working spaces.


Ecobook offers a variety of core features, including meeting room and desk booking systems, digital signage panels, visitor management, data analytics, and integration with Microsoft 365 and Google Workspace. Users can book and check in through web portals, mobile apps, or digital signage. The platform also includes intelligent recommendation features to prevent resource conflicts, streamline workspace management, enhance employee experience, and support the hybrid work model for greater collaboration.


This document demonstrates how to integrate the UG65 gateway directly with the Ecobook platform, using the AM308 and VS340 devices as examples to walk through the complete setup process.


1.  Requirements

● Gateway Model: UG65 (UG56 and UG67 are also supported)

● Sensor Models: AM308, VS340

● Internet Access: The gateway must be connected to the internet


Important Note:

Ecobook currently supports AM series products, as well as the VS340 and VS341 models. Support for more types of sensors is continuously being added. For the latest device compatibility information, please contact Ecobook directly.



2.  Obtain Basic Platform Information

Visit: Meeting Room Booking System | Desk Booking System | Ecobook 

Click the "Request Demo" button and fill in the required information based on your actual use case. In the "Message" field, clearly specify the types of devices and gateways you intend to use. After receiving your request, the Ecobook team will reach out and provide two key parameters:

● URL Endpoint (varies depending on sensor type)

● Token (sensitive information, not displayed here)

● API Documentation:

API Doc - Ecobook Events Services System Specifications (v1.0)


3.  Gateway Configuration

3.1.  Gateway Configuration

Log in to the gateway management UI ( refer this article )and follow the screenshots provided in the guide.

(If already enabled, you can skip this step.)

Once completed, the built-in network server is ready.


3.2.  Add AM308 Device

Refer to the guide: "How to Connect LoRaWAN Nodes to Milesight Gateway" for step-by-step instructions.

After adding, the result should look like this:


3.3.  Configure Decode Script

Refer to the guide: "How to Use Payload Codec on Milesight Gateway". 

When adding custom decoding logic, insert your code inside the milesight(...) function, just before the “return decoded;” line. 

This ensures your logic is executed properly and included in the final output.


● If using AM series sensors, add the following code:

 // The following code is for AM series devices only
    decoded.device_name = LoRaObject.devEUI;
    decoded.virus_index = 0; // The device doesn't have this value, temporarily set to 0
    decoded.pm1 = 0; // The device doesn't have this value, temporarily set to 0 
    decoded.pm25 = decoded.pm2_5;
    decoded.pm4 = 0; // The device doesn't have this value, temporarily set to 0 
    decoded.co = 0; // The device doesn't have this value, temporarily set to 0
    decoded.ozone = (typeof decoded.o3 !== 'undefined') ? decoded.o3 : 0; // Only specific models like AM319 have O3 detection
    decoded.no2 = 0; // The device doesn't have this value, temporarily set to 0
    decoded.light = decoded.light_level;
    decoded.sound = 0; // Only the WS302 model has this field
    decoded.h2s = 0; // Only the GS301 model has this field, and the field name can be used directly
    decoded.nh3 = 0; // Only the GS301 model has this field, and the field name can be used directly
    decoded.no = 0;  // The device doesn't have this value, temporarily set to 0 
    decoded.so2 = 0; // The device doesn't have this value, temporarily set to 0 
    decoded.o2 = 0; // The device doesn't have this value, temporarily set to 0 
    decoded.hcho = (typeof decoded.hcho !== 'undefined') ? decoded.hcho : 0; // Only specific models like AM319 have HCHO detection

After saving the script, modify the AM308 device configuration to associate it with the custom decoder.


● If using VS340 or VS341, use the following decode script:

// The following code is for VS340 and VS341 devices only
decoded.device_name = LoRaObject.devEUI;
decoded.occupied = decoded.occupancy === 0 ? "false" : "true";
decoded.count = 0; // The device doesn't have this value


3.4.  Configure Gateway HTTP Settings

Refer to the guide: "How to Connect Milesight LoRaWAN Gateway to HTTP(s) Server?". The key step here is to configure the URL endpoint and token provided by Ecobook.

After configuration, the screen should look like this:

At this point, the gateway setup is complete. After a short wait, the sensor will automatically report data, which you can then monitor.


4.  Observe Data

According to the API documentation, each type of sensor has a corresponding endpoint where you can check real-time data. Follow the instructions in the document to perform the query.

Below is the sample data from AM308 and AM319:

And the sample data from VS340:


After completing the integration, your sensors are now capable of transmitting real-time data to the Ecobook platform via the Milesight gateway. 


This real-time data serves as a foundation for developing intelligent workplace applications. 


For instance, Ecobook utilizes occupancy sensor data to automate functions such as check-ins, check-outs, and the cancellation of unused bookings, thereby enhancing meeting room utilization and minimizing manual interventions. Additionally, the platform can analyze environmental parameters, like temperature, humidity, and air quality, to optimize workspace comfort and efficiency. 


By leveraging these data-driven insights, organizations can create more responsive and efficient hybrid work environments.


-END-