Minimum Helios firmware version = 24.11.0.23030
Provided under MIT license
MinimumEssentialsFrameworkVersion = 1.16.0
Type: megapixelhelios
{
"key": "display-1",
"uid": 1,
"name": "Megapixel Helios",
"group": "display",
"type": "megapixelHelios",
"properties": {
"control": {
"method": "https",
"tcpSshProperties": {
"address": "192.168.1.100",
"port": 443,
"username": "{as defined in HELIOS web application}",
"password": "{as defined in HELIOS web application}",
"autoReconnect": true,
"autoReconnectIntervalMs": 10000
}
},
"brightness":{
"high": 60,
"medium": 40,
"low": 20
},
"presets":[
{ "name": "HDMI1", "presetName": "HDMI1" },
{ "name": "HDMI2", "presetName": "HDMI2" },
{ "name": "SDI1" , "presetName": "SDI1" },
{ "name": "SDI2" , "presetName": "SDI2" }
]
}
}
The port
object is only needed when overriding the default HTTP 80
or HTTPS 443
.
{
"key": "devices-bridge",
"uid": 2,
"group": "api",
"type": "eiscApiAdvanced",
"properties": {
"control": {
"tcpSshProperties": {
"address": "127.0.0.2",
"port": 0
},
"ipid": "a6",
"method": "ipidTcp"
},
"devices": [
{ "deviceKey": "display-1" , "joinStart": 1 }
]
}
}
Join Number | Join Span | Description | Type | Capabilities |
---|---|---|---|---|
1 | 1 | Power Off (blackout) | Digital | ToFromSIMPL |
2 | 1 | Power On (blackout) | Digital | ToFromSIMPL |
3 | 1 | Poll (public API) | Digital | FromSIMPL |
4 | 1 | Redundancy Role Main | Digital | ToFromSIMPL |
5 | 1 | Redundancy Role Backup | Digital | ToFromSIMPL |
6 | 1 | Redundancy Role Offline | Digital | ToFromSIMPL |
7 | 1 | Redundancy State Main | Digital | FromSIMPL |
8 | 1 | Redundancy State Backup | Digital | FromSIMPL |
7 | 1 | Redundancy State Active | Digital | ToSIMPL |
8 | 1 | Redundancy State Standby | Digital | ToSIMPL |
9 | 1 | Redundancy State Mixed | Digital | ToSIMPL |
31 | 1 | Test Pattern On | Digital | ToFromSIMPL |
32 | 1 | Test Pattern Off | Digital | ToFromSIMPL |
33 | 1 | Brightness High | Digital | ToFromSIMPL |
34 | 1 | Brightness Medium | Digital | ToFromSIMPL |
35 | 1 | Brightness Low | Digital | ToFromSIMPL |
41 | 1 | Hdmi1 Hotplug | Digital | FromSIMPL |
42 | 1 | Hdmi2 Hotplug | Digital | FromSIMPL |
41 | 1 | Hdmi1 Invalid | Digital | ToSIMPL |
42 | 1 | Hdmi2 Invalid | Digital | ToSIMPL |
50 | 1 | Is Online | Digital | ToSIMPL |
Join Number | Join Span | Description | Type | Capabilities |
---|---|---|---|---|
3 | 1 | Response Code | AnalogSerial | ToSIMPL |
21 | 1 | Preset select by presetId |
AnalogSerial | ToFromSIMPL |
33 | 1 | Brightness | AnalogSerial | ToFromSIMPL |
Join Number | Join Span | Description | Type | Capabilities |
---|---|---|---|---|
1 | 1 | Device Name | Serial | ToSIMPL |
3 | 1 | Response Content | Serial | ToSIMPL |
10 | 1 | Input select by inputName |
Serial | ToFromSIMPL |
21 | 1 | Preset select by presetName |
Serial | ToFromSimpl |
- The API document (see
docs
folder) tracks bothrole
andstate
objects. - The
role
API call refers to the long-term role assigned to the device (main vs backup), not typically changed. - The
state
API call refers to both the requested and reported state of the device. - The device is capable of detecting loss of video from the primary or
main
controller and automatically switchesstate
as needed. - The device will report current state as either
active
,standby
, ormixed
. - The various
state
definitions reported above cannot be requested. - The only valid
state
the device accepts ismain
orbackup
. - The
state
request ofmain
vsbackup
should be sent to override the automatic switch reported. - Hotplug requests utilize manufacturer private API which may change with firmware.
Public Methods that can be used with devjson
to test controls.
devjson:1 {"deviceKey":"display-1","methodName":"PowerOn" ,"params":[ ]}
devjson:1 {"deviceKey":"display-1","methodName":"PowerOff" ,"params":[ ]}
devjson:1 {"deviceKey":"display-1","methodName":"Poll" ,"params":[ ]}
devjson:1 {"deviceKey":"display-1","methodName":"GetRedundancyState" ,"params":[ ]}
devjson:1 {"deviceKey":"display-1","methodName":"SetRedundancyRoleToMain" ,"params":[ ]}
devjson:1 {"deviceKey":"display-1","methodName":"SetRedundancyRoleToBackup" ,"params":[ ]}
devjson:1 {"deviceKey":"display-1","methodName":"SetRedundancyRoleToOffline" ,"params":[ ]}
devjson:1 {"deviceKey":"display-1","methodName":"SetRedundancyStateToMain" ,"params":[ ]}
devjson:1 {"deviceKey":"display-1","methodName":"SetRedundancyStateToBackup" ,"params":[ ]}
devjson:1 {"deviceKey":"display-1","methodName":"SetBrightness" ,"params":["50" ]}
devjson:1 {"deviceKey":"display-1","methodName":"GetPresetsList" ,"params":[ ]}
devjson:1 {"deviceKey":"display-1","methodName":"RecallPresetById" ,"params":[1 ]}
devjson:1 {"deviceKey":"display-1","methodName":"RecallPresetByName" ,"params":["full" ]}
devjson:1 {"deviceKey":"display-1","methodName":"TestPatternOn" ,"params":[ ]}
devjson:1 {"deviceKey":"display-1","methodName":"TestPatternOff" ,"params":[ ]}
devjson:1 {"deviceKey":"display-1","methodName":"RecallInputByName" ,"params":["hdmi1"]}
devjson:1 {"deviceKey":"display-1","methodName":"HotplugHdmi1" ,"params":[ ]}
devjson:1 {"deviceKey":"display-1","methodName":"HotplugHdmi2" ,"params":[ ]}