Environmental Monitoring widget

💡

This page describes the dedicated data structure and provide an example for API
Common Solutions when widget type = RT_MEDIA

Player Common Solution

playerIds

array[string]

required

A collection of player IDs to be handled. At most 100 player IDs can be handled simultaneously.

schedule

object

optional

Playback schedule. If this is empty, the playback will be repeated 24 hours.

startDate

string

required

Playback start date, example: 2020-04-12.

endDate

string

required

Playback end date, example: 2020-12-22.

plans

array [object {3}]

required

Specific playback plan

pages

array [object {3}]

required

A collection of the contents to be played.

name

string

required

Page name

schedules

array [object {3}]

optional

It denotes the schedule list for this page. If it is empty, the page will be looped continuously for 24 hours. However, if both the program and page schedules are set, the page will play only during the times that overlap between the two schedules.

widgets

array [anyOf]

required

noticeUrl

string

optional

Solution download progress notification interface. This interface is used for notifying the customer of the solution download progress. The response time of the interface cannot exceed 3s.

{
    "playerIds": [
        "533d7c3151392500a57ba8b0d06436b4"
    ],
    "schedule": {
        "startDate": "2020-04-11",
        "endDate": "2060-05-12",
        "plans": [
            {
                "weekDays": [
                    1,
                    2,
                    3,
                    4,
                    5
                ],
                "startTime": "00:00",
                "endTime": "22:00"
            },
            {
                "weekDays": [
                    0,
                    6
                ],
                "startTime": "00:33",
                "endTime": "22:00"
            }
        ]
    },
    "pages": [
        {
            "name": "a-page",
            "widgets": [
                {
                    "zIndex": 1,
                    "type": "RT_MEDIA",
                    "fontFamily": "SimSun",
                    "labelFontSize": 18,
                    "valueFontSize": 18,
                    "unitFontSize": 18,
                    "bold": true,
                    "italic": true,
                    "underline": true,
                    "textColor": "#F90840",
                    "refreshPeriod": 600000,
                    "style": 1,
                    "playMode": "STATIC",
                    "seedByPixelEnable": false,
                    "speedGear": 3,
                    "speedPixel": 160,
                    "customLabel": {
                        "NOI": {
                            "name": "NAIs",
                            "enable": true,
                            "unit": "ions/cm³"
                        },
                        "coII": {
                            "name": "CO2",
                            "enable": true,
                            "unit": "ppm"
                        },
                        "UVR": {
                            "name": "UV radiation",
                            "enable": true,
                            "unit": "nm"
                        },
                        "airHumidity": {
                            "name": "Air humidity",
                            "enable": true,
                            "unit": "%RH"
                        },
                        "airPressure": {
                            "name": "Air pressure",
                            "enable": true,
                            "type": 0,
                            "unit": "bar"
                        },
                        "ambiantLight": {
                            "name": "Ambient Light",
                            "enable": true,
                            "unit": "Lux"
                        },
                        "noise": {
                            "name": "Noise",
                            "enable": true,
                            "unit": "db"
                        },
                        "pmC": {
                            "name": "PM100",
                            "enable": true,
                            "unit": "μg/m³"
                        },
                        "pmIIV": {
                            "name": "PM2.5",
                            "enable": true,
                            "unit": "μg/m³"
                        },
                        "pmX": {
                            "name": "PM10",
                            "enable": true,
                            "unit": "μg/m³"
                        },
                        "rainfall": {
                            "name": "Rainfall",
                            "enable": true,
                            "unit": "mm"
                        },
                        "snowfall": {
                            "name": "Snowfall",
                            "enable": true,
                            "unit": "mm"
                        },
                        "soilMoisture": {
                            "name": "Soil moisture",
                            "enable": true,
                            "unit": "rh"
                        },
                        "soilPH": {
                            "name": "Soil pH",
                            "enable": true,
                            "unit": "ph"
                        },
                        "soilTemperature": {
                            "name": "Soil temperature",
                            "enable": true,
                            "type": 0,
                            "unit": "℃"
                        },
                        "sunshineDuration": {
                            "name": "Sunshine duration",
                            "enable": true,
                            "unit": "W/m²"
                        },
                        "temperature": {
                            "name": "Temperature",
                            "enable": true,
                            "type": 0,
                            "unit": "C°",
                            "tempCompensate": 0
                        },
                        "windDirection": {
                            "name": "Wind direction",
                            "enable": true,
                            "templates": [
                                "North Wind",
                                "Northeast Wind",
                                "East Wind",
                                "Southeast Wind",
                                "South Wind",
                                "Southwest Wind",
                                "West Wind",
                                "Northwest Wind
"
                            ]
                        },
                        "windSpeed": {
                            "name": "Wind Speed",
                            "enable": true,
                            "type": 0,
                            "unit": "km/h"
                        }
                    },
                    "duration": 10000,
                    "layout": {
                        "x": "0%",
                        "y": "0%",
                        "width": "50%",
                        "height": "50%"
                    }
                }
            ]
        }
    ]
}