Skip to content

GPIO

Trigger GPIO Output

POST /api/gpio/:device/outputs/:output/write

Set the value of a GPIO output port.

Parameter Type Description
:device String or Number (optional) The name or index of the GPIO device. If not provided, the first available device will be used.
:output Number The output port number to control.

Request Body 

1
2
3
{
  "value": true
}

Parameter Type Description
value Boolean The value to set the output.

Simulate GPIO Input Trigger

POST /api/gpio/:device/inputs/:input/simulate

Simulate a trigger on an input port.

Parameter Type Description
:device String or Number (optional) The name or index (0-based) of the GPIO device.
:input Number The input port number to simulate a trigger on.

Event Listeners (for input triggers)

You can use these methods to listen and react to GPIO events:

  • .on('trigger', e => {}) - Add a listener for input triggers.
  • .once('trigger', e => {}) - Add a one-time listener.
  • .off('trigger', e => {}) - Remove a listener.
  • .simulate(InputNumber) - Simulate an input trigger.
  • .write(OutputNumber, Boolean) - Write a value to an output port.

Get Info of the Erizos Server

GET /api/info

Returns all the information regarding the Erizos Server.

Response

The response is the information of the Studio Server

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
    "info": {
        "shortName": "Studio Server",
        "longName": "Erizos Studio Server",
        "version": "0.0.0.13778",
        "buildDate": "2024-03-11T07:57:50.873Z",
        "startTime": "2024-03-15 01:23:34",
        "license": {
            "expiry": "2025-07-31",
            "features": {}
        },
        "session": "246bc8c57fde089d57a57c8dcaf715d8",
        "mode": "SERVER"
    }
}

Get Settings of Erizos Server

GET /api/settings

Returns all the information regarding the Erizos Server settings

Response

The response is the information of the Studio Server Settings

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
{
    "log": {
        "level": "VERBOSE",
        "daysToKeep": 30
    },
    "redundancy": {
        "enabled": false,
        "replica": "",
        "machines": []
    },
    "general": {
        "name": "",
        "address": ""
    },
    "systems": {
        "ue": {
            "enabled": true,
            "source": "FOLDER",
            "creativehub": {
                "server": "DESKTOP-CVIC5J6",
                "username": "admin",
                "password": "ENC:7fab6adc9420ff1dddb8f7476859"
            },
            "root": "D:\\My\\Project\\Directory",
            "runInEditor": false,
            "livePreview": true,
            "routeCommands": true
        }
        ...
    ...
}
}

Get all Servers

GET /api/servers

Returns all the Erizos Servers found in the network.

Response

The response is an array of Servers

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
[
    {
        "app": "Agent",
        "hostname": "DESKTOP-CVIC5J6",
        "name": "DESKTOP-CVIC5J6 - Agent",
        "port": 5510,
        "addresses": [
            "192.168.56.1",
            "172.22.158.135",
            "192.168.1.194"
        ]
    },
    {
        "app": "Studio Server",
        "hostname": "DESKTOP-CVIC5J6",
        "name": "DESKTOP-CVIC5J6 - Studio Server",
        "port": 5550,
        "addresses": [
            "192.168.56.1",
            "172.22.158.135",
            "192.168.1.194"
        ]
    }
]

Restart the App

Restarts the App

POST /api/restart

Response 

1
2
3
{
    "message": "Restarting"
}

Get all UI Mappings

GET /api/uimappings

Returns all the UI Mappings

Response

The response is an array of UI Mapping

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
[
    {
        "_id": "65e884f19d3c19dde220c2db",
        "ui": "65e884e89d3c19dde220c2d2",
        "key": "65e70de4e26a8da333766cf7",
        "show": "65e70de4e26a8da333766cf7",
        "disabled": false,
        "createdAt": "2024-03-06T15:00:01.038Z",
        "updatedAt": "2024-03-11T13:52:37.463Z",
        "__v": 0,
        "_type": "UIMAPPING"
    }
]