Global

Methods

changePanelSpyRegistry(host, tcp, url, src, events) → {Obj}

Perform an changePanelSpyRegistry command
Parameters:
Name Type Description
host Obj {ip, port}
tcp int TCP Port for receiving events
url string URL of receiving xml-rpc server
src Obj {node, port}
events Obj {rotate, key, func, numKey}
Source:
Returns:
status - {status, value}
Type
Obj

killXp(host, src, dest) → {Obj}

Perform a killXp command
Parameters:
Name Type Description
host Obj {ip, port}
src Obj {net, node, portId}
dest Obj {net, node, portId}
Source:
Returns:
status - {status, value}
Type
Obj

registerForAllEvents(host, tcp, url) → {Obj}

Perform a RegisterForAllEvents command
Parameters:
Name Type Description
host Obj {ip, port}
tcp int TCP Port for receiving events
url string URL of receiving xml-rpc server
Source:
Returns:
status - {status, value}
Type
Obj

run(host, local)

Setup the XML-RPC Listening Server
Parameters:
Name Type Description
host Obj {ip, port}
local Obj {ip, port}
Source:

setXp(host, src, dest) → {Obj}

Perform a setXp command
Parameters:
Name Type Description
host Obj {ip, port}
src Obj {net, node, portId}
dest Obj {net, node, portId}
Source:
Returns:
status - {status, value}
Type
Obj

unregisterForAllEvents(host, tcp, url) → {Obj}

Perform an unRegisterForAllEvents command
Parameters:
Name Type Description
host Obj {ip, port}
tcp int TCP Port for receiving events
url string URL of receiving xml-rpc server
Source:
Returns:
status - {status, value}
Type
Obj

Type Definitions

standardCallback

standardCallback
Source:

Events

ConnectArtistFailure

ConnectArtistFailure alert from RRCS
Type:
  • object
Properties:
Name Type Description
TransKey string Transaction Key ID from RRCS
Source:
Returns:
  • callback - [TransKey, ErrorCode]
    Type
    array
  • artistStatus - 0 for failure
    Type
    io.emit

ConnectArtistRestored

ConnectArtistRestored alert from RRCS
Type:
  • object
Properties:
Name Type Description
TransKey string Transaction Key ID from RRCS
GatewayState string Either "Working" or "Standby"
Source:
Returns:
  • callback - [TransKey, ErrorCode]
    Type
    array
  • artistStatus - 1 for connected
    Type
    io.emit

GetAlive

GetAlive request from RRCS
Source:
Returns:
callback - [ErrorCode]
Type
array

PanelSpyFuncKeyEvent

PanelSpyFuncKeyEvent alert from RRCS
Type:
  • array
Properties:
Name Type Description
TransKey string Transaction Key ID from RRCS
FuncKeyEventData array {Node, Port, FuncKeyNo, FuncKeyAction, {Shift: bool, Hs: bool, Opt: bool, Beep: bool, Norm: bool}}
Source:
Returns:
  • callback - ["alive"]
    Type
    array
  • event - {port, subpanel, key, event, details: {KeyAction}}
    Type
    io.emit

PanelSpyKeyEvent

PanelSpyKeyEvent alert from RRCS
Type:
  • array
Properties:
Name Type Description
TransKey string Transaction Key ID from RRCS
KeyEventData array {Node, Port, SubPanel, KeyNo, KeyType, IsKeyLatched, KeyAction, {Shift: bool, Hs: bool, Opt: bool, Beep: bool, Norm: bool}}
Source:
Returns:
  • callback - ["alive"]
    Type
    array
  • event - {port, subpanel, key, event, details: {KeyAction, KeyType}}
    Type
    io.emit

PanelSpyRotateEvent

PanelSpyRotateEvent alert from RRCS
Type:
  • array
Properties:
Name Type Description
TransKey string Transaction Key ID from RRCS
RotateEventData array {Node, Port, SubPanel, KeyNo, RotationTicks, {Shift: bool, Hs: bool, Opt: bool, Beep: bool, Norm: bool}}
Source:
Returns:
  • callback - ["alive"]
    Type
    array
  • event - {port, subpanel, key, event, details: {RotationTicks}}
    Type
    io.emit

PanelSpyStateChanged

PanelSpyStateChanged alert from RRCS
Type:
  • array
Properties:
Name Type Description
TransKey string Transaction Key ID from RRCS
PanelSpy array [{Node, Port, {Rotate: state}, {Key: state}, {FuncKey: state}, {NumKey: state}}]
Source:
Returns:
  • callback - ["alive"]
    Type
    array
  • panelSpy - state
    Type
    io.emt