Constructor
new RRCS_Client(host, port)
Setup connectivity to RRCS
Parameters:
| Name | Type | Description |
|---|---|---|
host |
string | [RRCS IP Address] |
port |
int | [RRCS port number] |
Methods
(async) getAllActivePortClones() → {array}
Get All Active Port Clones
Returns:
- Type
- array
(async) getAllActiveXps() → {object}
Get all properties from a particular object
Returns:
{TransKey, XP Count: XPs in this obj, XP#n...: [srcNet, srcNode, srcPort, destNet, destNode, destPort]}
- Type
- object
(async) getAllIFBs(id) → {array}
Get all IFBs
Parameters:
| Name | Type | Description |
|---|---|---|
id |
int | ObjectID |
Returns:
{ Input: { IsInput: bool, Node: int, Port: int }, Label: str, LongName: str, MixMinus: { IsInput: bool, Node: int, Port: int }, Number: int, ObjectID: int, Output: { IsInput: bool, Node: int, Port: int }, Owner: int }
- Type
- array
(async) getAllPorts(id) → {array}
Get all ports in the system
Parameters:
| Name | Type | Description |
|---|---|---|
id |
int | ObjectID |
Returns:
{Input: bool, KeyCount: int, Label: str, Name: str, Node: int, ObjectID: int, Output: bool, PageCount: int, Port: int, PortType: str}
- Type
- array
(async) getAllTrunkPorts() → {array}
Get all trunk ports
Returns:
- Type
- array
(async) getGPInputStatus(src) → {getGPInputStateCb}
Get GP input state
Parameters:
| Name | Type | Description |
|---|---|---|
src |
object | source port object: {net, node, port, gpio} |
Returns:
- Type
- getGPInputStateCb
(async) getGPOutputStatus(src) → {getGPOutputStateCb}
Get GP output state
Parameters:
| Name | Type | Description |
|---|---|---|
src |
object | source port object: {net, node, port, gpio} |
Returns:
- Type
- getGPOutputStateCb
(async) getInputGain(src) → {getInputGainCb}
Get input gain of a port
Parameters:
| Name | Type | Description |
|---|---|---|
src |
object | source port object: {net, node, port} |
Returns:
- Type
- getInputGainCb
(async) getLogicSources() → {object}
Get Logic Sources
Returns:
{TransKey: int, ErrorCode: int, LogicSourceCount: int, LogicSource#x: [longName, label, Id, state]}
- Type
- object
(async) getObjectProperties(id) → {object}
Get all properties from a particular object
Parameters:
| Name | Type | Description |
|---|---|---|
id |
int | ObjectID |
Returns:
properites - Properites object varies depending on object type
- Type
- object
(async) getObjects() → {getObjectsCb}
Get all configured objects from the Artist System
Returns:
- Type
- getObjectsCb
(async) getOutputGain(src) → {getInputGainCb}
Get output gain of a port
Parameters:
| Name | Type | Description |
|---|---|---|
src |
object | source port object: {net, node, port} |
Returns:
- Type
- getInputGainCb
(async) getState() → {getStateCb}
Get current state of RRCS
Returns:
- Type
- getStateCb
(async) getTrunklineActivity() → {array}
Get trunk line activity
Returns:
{ DestTrAddr: { DestObjAddr: int, NetTrAddr: int }, Priority: int, SrcTrAddr: { NetTrAddr: int, SrcObjAddr: int }, TrunkCmdType: int, TrunklinePath: [ { dNetTrAddr: int, dPortTrAddr: int, sNetTrAddr: int, sPortTrAddr: int }, { dNetTrAddr: int, dPortTrAddr: int, sNetTrAddr: int, sPortTrAddr: int } ] }
- Type
- array
(async) getTrunklineSetup() → {array}
Get trunk line setup
Returns:
{DestNetName: str, DestNetTrAddr: int, DestPortName: str, DestTrAddr: int, SrcNetName: str, SrcNetTrAddr: int, SrcPortName: str, SrcPortTrAddr: int}
- Type
- array
(async) getVersion() → {getVersionCb}
Get current version of RRCS
Returns:
- Type
- getVersionCb
(async) getXpVolume(src, dest) → {getXpVolumeCb}
Get a specific XP Volume
Parameters:
| Name | Type | Description |
|---|---|---|
src |
object | source port object: {net, node, port} |
dest |
object | destination port object: {net, node, port} |
Returns:
- Type
- getXpVolumeCb
(async) isConnectedToArtist() → {isConnectedToArtistCb}
Check if RRCS is connected to Artist