Pepperdash.Essentials.Plugins.Megapixel.Helios 1.5.0-4-series-updates.2

Megapixel Helios (c) 2024

Minimum Helios firmware version

• 24.11.0.23030

Minimum Essentials Framework Versions

• 2.4.4

License

Provided under MIT license

Configuration Object

Device

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.

Bridge

{
	"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 Map

Digitals

Analogs

Serials

POINT OF CLARIFICATION

1. The API document (see docs folder) tracks both role and state objects.
2. The role API call refers to the long-term role assigned to the device (main vs backup), not typically changed.
3. The state API call refers to both the requested and reported state of the device.
4. The device is capable of detecting loss of video from the primary or main controller and automatically switches state as needed.
5. The device will report current state as either active, standby, or mixed.
6. The various state definitions reported above cannot be requested.
7. The only valid state the device accepts is main or backup.
8. The state request of main vs backup should be sent to override the automatic switch reported.
9. Hotplug requests utilize manufacturer private API which may change with firmware.

DEVJSON Commands

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":[       ]}

Supported Types

• megapixelHelios

Interfaces Implemented

• IBridgeAdvanced
• IOnline
• IHasPowerControlWithFeedback
• IHasFeedback
• IRestfulComms

Base Classes

• JoinMapBaseAdvanced
• TwoWayDisplayBase
• EventArgs

Public Methods

• public void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey, EiscApiAdvanced bridge)
• public void Poll()
• public void PollPrivateApi()
• public void HotplugHdmi1()
• public void HotplugHdmi2()
• public void GetRedundancyState()
• public void SetRedundancyRoleToMain()
• public void SetRedundancyRoleToBackup()
• public void SetRedundancyRoleToOffline()
• public void SetRedundancyStateToMain()
• public void SetRedundancyStateToBackup()
• public void SetBrightness(ushort brightness)
• public void TestPatternOn()
• public void TestPatternOff()
• public void GetPresetsList()
• public void RecallPresetById(uint id)
• public void RecallPresetByName(string name)
• public void RecallInputByName(string name)
• public void SendRequest(string requestType, string path, string content)
• public void SendRequest(RequestType requestType, string path, string content)
• public void SendRequest(string requestType, string path, string content)
• public void SendRequest(RequestType requestType, string path, string content)

Bool Feedbacks

• IsOnline
• Hdmi1InvalidFeedback
• Hdmi2InvalidFeedback
• Sdi1IsValidFeedback
• Sdi2IsValidFeedback
• TestPatternIsOnFeedback
• RedundancyRoleIsMainFeedback
• RedundancyRoleIsBackupFeedback
• RedundancyRoleIsOfflineFeedback
• RedundancyStateIsActiveFeedback
• RedundancyStateIsMixedFeedback
• RedundancyStateIsStandbyFeedback

Int Feedbacks

• ResponseCodeFeedback
• BrightnessFeedback
• CurrentPresetIdFeedback

String Feedbacks

• ResponseContentFeedback
• ResponseErrorFeedback
• CurrentInputNameFeedback
• CurrentPresetNameFeedback