JSDoc: Class: cbusLibrary

new cbusLibrary()

Source:

cbuslibrary.js, line 48

Methods

decode(message) → {Object}

Decode a CBUS message
This will decode both 11 bit ID CBUS messages and also 29 bit extended messages, as these are identified in the message itself
The actual CBUS messsage is expected to be in 'Grid connect' ASCII format, either as a plain string
or as the 'encoded' property in a JSON object
NOTE: doesn't preserve the original input JSON, but creates new JSON object as output

Parameters:

Name	Type	Description
`message`	String	CAN BUS message in a plain string or JSON format ('Grid connect' ASCII)

Source:

cbuslibrary.js, line 151

Returns:

Decoded properties as a JSON structure - content dependant on specific message, but will always have 'encoded' as the original input message, and also 'ID_TYPE' & 'text' elements
'ID_TYPE' will be either 'S' (11 bit CBUS message) or 'X' (29 bit extended message) - or blank if not valid

Type: Object

Example

// 11 bit CBUS message
   {
     "encoded": ":SA780NE1FF00007F01FF01;",
     "ID_TYPE":"S",
     "mnemonic": "PLOC",
     "opCode": "E1",
     "session": 255,
     "address": 0,
     "speed": 127,
     "direction": "Reverse",
     "Fn1": 1,
     "Fn2": 255,
     "Fn3": 1,
     "text": "PLOC (E1) Session 255 Address 0 Speed/Dir 127 Direction Reverse Fn1 1 Fn2 255 Fn3 1"
   }

// 29 bit firmware download control message
   {
      "encoded":":X00080004N000000000D040000;",
      "ID_TYPE":"X",
      "operation":"PUT",
      "type":"CONTROL",
      "address":"000000",
      "RESVD":0,
      "CTLBT":13,
      "SPCMD":4,
      "CPDTL":0,
      "CPDTH":0
      "text": {"encoded":":X00080004N000000000D040000;","ID_TYPE":"X","operation":"PUT","type":"CONTROL","address":"000000","RESVD":0,"CTLBT":13,"SPCMD":4,"CPDTL":0,"CPDTH":0}
   }

encode(message) → {Object}

encode a CBUS message
This will encode either a 11 bit 'standard' or 29 bit 'extended' ID CBUS message from a supplied JSON object into a 'grid connect' ascii format
If the correct JSON properties for the parameters for the encoding are not present, an exception will be thrown
The JSON properties shared by both encode() & decode() are identical - however note decode() may return more properties than encode() requires

Parameters:

Name	Type	Description
`message`	Object	CBUS message properties as a JSON object

Source:

cbuslibrary.js, line 649

Returns:

returns the original input JSON object with the resultant encoded CBUS message added using the 'encoded' property

Type: Object

encode_EXT_PUT_CONTROL(address, CTLBT, SPCMD, CPDTL, CPDTH) → {string}

29 bit Extended CAN Identifier 'Put Control' firmware download message

Parameters:

Name	Type	Description
`address`	string	6 digit hexadecimal number 000000 to FFFFFF
`CTLBT`	int	0 to 255
`SPCMD`	int	0 to 255
`CPDTL`	int	0 to 255
`CPDTH`	int	0 to 255

Source:

cbuslibrary.js, line 1489

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Example :X00080004N000000000D040000;
29 bit fixed header (:X00080004N.......)

Type: string

encode_EXT_PUT_DATA(data) → {string}

29 bit Extended CAN Identifier 'Put Data' firmware download message

Parameters:

Name	Type	Description
`data`	array	8 byte data array

Source:

cbuslibrary.js, line 1502

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Example :X00080005N20EF04F0FFFFFFFF;
29 bit fixed header (:X00080004N.......)

Type: string

encode_EXT_RESPONSE(response) → {string}

29 bit Extended CAN Identifier firmware download 'response' message

Parameters:

Name	Type	Description
`response`	int	response number to firmware download control message

Source:

cbuslibrary.js, line 1522

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Example :X80180004N02;
29 bit fixed header (:X80080000N.......)

Type: string

encodeACDAT(nodeNumber, data1, data2, data3, data4, data5) → {String}

opCode F6

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`data1`	int	0 to 255
`data2`	int	0 to 255
`data3`	int	0 to 255
`data4`	int	0 to 255
`data5`	int	0 to 255

Source:

cbuslibrary.js, line 5033

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<F6><nodeNumber hi><nodeNumber lo><data1><data2><data3><data4><data5>

Type: String

encodeACK() → {String}

opCode 00

Source:

cbuslibrary.js, line 1542

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=2><CANID>]<00>

Type: String

encodeACOF(nodeNumber, eventNumber) → {String}

opCode 91

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`eventNumber`	int	0 to 65535

Source:

cbuslibrary.js, line 3157

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<91><nodeNumber hi><nodeNumber lo><eventNumber hi><eventNumber lo>

Type: String

encodeACOF1(nodeNumber, eventNumber, data1) → {String}

opCode B1

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`eventNumber`	int	0 to 65535
`data1`	int	0 to 255

Source:

cbuslibrary.js, line 3726

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<B1><nodeNumber hi><nodeNumber lo><eventNumber hi><eventNumber lo><data1>

Type: String

encodeACOF2(nodeNumber, eventNumber, data1, data2) → {String}

opCode D1

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`eventNumber`	int	0 to 65535
`data1`	int	0 to 255
`data2`	int	0 to 255

Source:

cbuslibrary.js, line 4254

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<D1><nodeNumber hi><nodeNumber lo><eventNumber hi><eventNumber lo><data1><data2>

Type: String

encodeACOF3(nodeNumber, eventNumber, data1, data2, data3) → {String}

opCode F1

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`eventNumber`	int	0 to 65535
`data1`	int	0 to 255
`data2`	int	0 to 255
`data3`	int	0 to 255

Source:

cbuslibrary.js, line 4847

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<F1><nodeNumber hi><nodeNumber lo><eventNumber hi><eventNumber lo><data1><data2><data3>

Type: String

encodeACON(nodeNumber, eventNumber) → {String}

opCode 90

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`eventNumber`	int	0 to 65535

Source:

cbuslibrary.js, line 3129

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<90><nodeNumber hi><nodeNumber lo><eventNumber hi><eventNumber lo>

Type: String

encodeACON1(nodeNumber, eventNumber, data1) → {String}

opCode B0

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`eventNumber`	int	0 to 65535
`data1`	int	0 to 255

Source:

cbuslibrary.js, line 3695

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<B0><nodeNumber hi><nodeNumber lo><eventNumber hi><eventNumber lo><data1>

Type: String

encodeACON2(nodeNumber, eventNumber, data1, data2) → {String}

opCode D0

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`eventNumber`	int	0 to 65535
`data1`	int	0 to 255
`data2`	int	0 to 255

Source:

cbuslibrary.js, line 4220

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<D0><nodeNumber hi><nodeNumber lo><eventNumber hi><eventNumber lo><data1><data2>

Type: String

encodeACON3(nodeNumber, eventNumber, data1, data2, data3) → {String}

opCode F0

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`eventNumber`	int	0 to 65535
`data1`	int	0 to 255
`data2`	int	0 to 255
`data3`	int	0 to 255

Source:

cbuslibrary.js, line 4810

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<F0><nodeNumber hi><nodeNumber lo><eventNumber hi><eventNumber lo><data1><data2><data3>

Type: String

encodeALOC(session, allocatonCode) → {String}

opCode 43

Parameters:

Name	Type	Description
`session`	int	number 0 to 255
`allocatonCode`	int	number 0 to 255

Source:

cbuslibrary.js, line 2069

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=2><CANID>]<43><session><allocatonCode>

Type: String

encodeARDAT(nodeNumber, data1, data2, data3, data4, data5) → {String}

opCode F7

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`data1`	int	0 to 255
`data2`	int	0 to 255
`data3`	int	0 to 255
`data4`	int	0 to 255
`data5`	int	0 to 255

Source:

cbuslibrary.js, line 5077

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<F7><nodeNumber hi><nodeNumber lo><data1><data2><data3><data4><data5>

Type: String

encodeAREQ(nodeNumber, eventNumber) → {String}

opCode 92

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`eventNumber`	int	0 to 65535

Source:

cbuslibrary.js, line 3185

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<92><nodeNumber hi><nodeNumber lo><eventNumber hi><eventNumber lo>

Type: String

encodeAROF(nodeNumber, eventNumber) → {String}

opCode 94

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`eventNumber`	int	0 to 65535

Source:

cbuslibrary.js, line 3241

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<94><nodeNumber hi><nodeNumber lo><eventNumber hi><eventNumber lo>

Type: String

encodeAROF1(nodeNumber, eventNumber, data1) → {String}

opCode B4

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`eventNumber`	int	0 to 65535
`data1`	int	0 to 255

Source:

cbuslibrary.js, line 3818

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<B4><nodeNumber hi><nodeNumber lo><eventNumber hi><eventNumber lo><data1>

Type: String

encodeAROF2(nodeNumber, eventNumber, data1, data2) → {String}

opCode D5

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`eventNumber`	int	0 to 65535
`data1`	int	0 to 255
`data2`	int	0 to 255

Source:

cbuslibrary.js, line 4388

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<D5><nodeNumber hi><nodeNumber lo><eventNumber hi><eventNumber lo><data1><data2>

Type: String

encodeAROF3(nodeNumber, eventNumber, data1, data2, data3) → {String}

opCode F4

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`eventNumber`	int	0 to 65535
`data1`	int	0 to 255
`data2`	int	0 to 255
`data3`	int	0 to 255

Source:

cbuslibrary.js, line 4952

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<F4><nodeNumber hi><nodeNumber lo><eventNumber hi><eventNumber lo><data1><data2><data3>

Type: String

encodeARON(nodeNumber, eventNumber) → {String}

opCode 93

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`eventNumber`	int	0 to 65535

Source:

cbuslibrary.js, line 3213

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<93><nodeNumber hi><nodeNumber lo><eventNumber hi><eventNumber lo>

Type: String

encodeARON1(nodeNumber, eventNumber, data1) → {String}

opCode B3

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`eventNumber`	int	0 to 65535
`data1`	int	0 to 255

Source:

cbuslibrary.js, line 3787

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<B3><nodeNumber hi><nodeNumber lo><eventNumber hi><eventNumber lo><data1>

Type: String

encodeARON2(nodeNumber, eventNumber, data1, data2) → {String}

opCode D4

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`eventNumber`	int	0 to 65535
`data1`	int	0 to 255
`data2`	int	0 to 255

Source:

cbuslibrary.js, line 4354

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<D4><nodeNumber hi><nodeNumber lo><eventNumber hi><eventNumber lo><data1><data2>

Type: String

encodeARON3(nodeNumber, eventNumber, data1, data2, data3) → {String}

opCode F3

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`eventNumber`	int	0 to 65535
`data1`	int	0 to 255
`data2`	int	0 to 255
`data3`	int	0 to 255

Source:

cbuslibrary.js, line 4915

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<F3><nodeNumber hi><nodeNumber lo><eventNumber hi><eventNumber lo><data1><data2><data3>

Type: String

encodeARSOF(nodeNumber, deviceNumber) → {String}

opCode 9E

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`deviceNumber`	int	0 to 65535

Source:

cbuslibrary.js, line 3524

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<9E><nodeNumber hi><nodeNumber lo><deviceNumber hi><deviceNumber lo>

Type: String

encodeARSOF1(nodeNumber, deviceNumber, data1) → {String}

opCode BE

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`deviceNumber`	int	0 to 65535
`data1`	int	0 to 255

Source:

cbuslibrary.js, line 4008

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<BE><nodeNumber hi><nodeNumber lo><deviceNumber hi><deviceNumber lo><data1>

Type: String

encodeARSOF2(nodeNumber, deviceNumber, data1, data2) → {String}

opCode DE

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`deviceNumber`	int	0 to 65535
`data1`	int	0 to 255
`data2`	int	0 to 255

Source:

cbuslibrary.js, line 4524

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<DE><nodeNumber hi><nodeNumber lo><deviceNumber hi><deviceNumber lo><data1><data2>

Type: String

encodeARSOF3(nodeNumber, deviceNumber, data1, data2, data3) → {String}

opCode FE

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`deviceNumber`	int	0 to 65535
`data1`	int	0 to 255
`data2`	int	0 to 255
`data3`	int	0 to 255

Source:

cbuslibrary.js, line 5319

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<FE><nodeNumber hi><nodeNumber lo><deviceNumber hi><deviceNumber lo><data1><data2><data3>

Type: String

encodeARSON(nodeNumber, deviceNumber) → {String}

opCode 9D

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`deviceNumber`	int	0 to 65535

Source:

cbuslibrary.js, line 3496

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<9D><nodeNumber hi><nodeNumber lo><deviceNumber hi><deviceNumber lo>

Type: String

encodeARSON1(nodeNumber, deviceNumber, data1) → {String}

opCode BD

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`deviceNumber`	int	0 to 65535
`data1`	int	0 to 255

Source:

cbuslibrary.js, line 3977

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<BD><nodeNumber hi><nodeNumber lo><deviceNumber hi><deviceNumber lo><data1>

Type: String

encodeARSON2(nodeNumber, deviceNumber, data1, data2) → {String}

opCode DD

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`deviceNumber`	int	0 to 65535
`data1`	int	0 to 255
`data2`	int	0 to 255

Source:

cbuslibrary.js, line 4490

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<DD><nodeNumber hi><nodeNumber lo><deviceNumber hi><deviceNumber lo><data1><data2>

Type: String

encodeARSON3(nodeNumber, deviceNumber, data1, data2, data3) → {String}

opCode FD

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`deviceNumber`	int	0 to 65535
`data1`	int	0 to 255
`data2`	int	0 to 255
`data3`	int	0 to 255

Source:

cbuslibrary.js, line 5281

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<FD><nodeNumber hi><nodeNumber lo><deviceNumber hi><deviceNumber lo><data1><data2><data3>

Type: String

encodeARST() → {String}

opCode 07

Source:

cbuslibrary.js, line 1689

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=0><CANID>]<07>

Type: String

encodeASOF(nodeNumber, deviceNumber) → {String}

opCode 99

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`deviceNumber`	int	0 to 65535

Source:

cbuslibrary.js, line 3382

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<99><nodeNumber hi><nodeNumber lo><deviceNumber hi><deviceNumber lo>

Type: String

encodeASOF1(nodeNumber, deviceNumber, data1) → {String}

opCode B9

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`deviceNumber`	int	0 to 65535
`data1`	int	0 to 255

Source:

cbuslibrary.js, line 3946

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<B9><nodeNumber hi><nodeNumber lo><deviceNumber hi><deviceNumber lo><data1>

Type: String

encodeASOF2(nodeNumber, deviceNumber, data1, data2) → {String}

opCode D9

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`deviceNumber`	int	0 to 65535
`data1`	int	0 to 255
`data2`	int	0 to 255

Source:

cbuslibrary.js, line 4456

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<D9><nodeNumber hi><nodeNumber lo><deviceNumber hi><deviceNumber lo><data1><data2>

Type: String

encodeASOF3(nodeNumber, deviceNumber, data1, data2, data3) → {String}

opCode F9

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`deviceNumber`	int	0 to 65535
`data1`	int	0 to 255
`data2`	int	0 to 255
`data3`	int	0 to 255

Source:

cbuslibrary.js, line 5155

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<F9><nodeNumber hi><nodeNumber lo><deviceNumber hi><deviceNumber lo><data1><data2><data3>

Type: String

encodeASON(nodeNumber, deviceNumber) → {String}

opCode 98

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`deviceNumber`	int	0 to 65535

Source:

cbuslibrary.js, line 3354

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<98><nodeNumber hi><nodeNumber lo><deviceNumber hi><deviceNumber lo>

Type: String

encodeASON1(nodeNumber, deviceNumber, data1) → {String}

opCode B8

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`deviceNumber`	int	0 to 65535
`data1`	int	0 to 255

Source:

cbuslibrary.js, line 3915

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<B8><nodeNumber hi><nodeNumber lo><deviceNumber hi><deviceNumber lo><data1>

Type: String

encodeASON2(nodeNumber, deviceNumber, data1, data2) → {String}

opCode D8

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`deviceNumber`	int	0 to 65535
`data1`	int	0 to 255
`data2`	int	0 to 255

Source:

cbuslibrary.js, line 4422

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<D8><nodeNumber hi><nodeNumber lo><deviceNumber hi><deviceNumber lo><data1><data2>

Type: String

encodeASON3(nodeNumber, deviceNumber, data1, data2, data3) → {String}

opCode F8

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`deviceNumber`	int	0 to 65535
`data1`	int	0 to 255
`data2`	int	0 to 255
`data3`	int	0 to 255

Source:

cbuslibrary.js, line 5118

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<F8><nodeNumber hi><nodeNumber lo><deviceNumber hi><deviceNumber lo><data1><data2><data3>

Type: String

encodeASRQ(nodeNumber, deviceNumber) → {String}

opCode 99

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`deviceNumber`	int	0 to 65535

Source:

cbuslibrary.js, line 3410

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<99><nodeNumber hi><nodeNumber lo><deviceNumber hi><deviceNumber lo>

Type: String

encodeBON() → {String}

opCode 03

Source:

cbuslibrary.js, line 1605

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=1><CANID>]<03>

Type: String

encodeBOOTM(nodeNumber) → {String}

opCode 5C

Parameters:

Name	Type	Description
`nodeNumber`	int	number 0 to 65535

Source:

cbuslibrary.js, line 2608

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<5C><nodeNumber hi><nodeNumber lo>

Type: String

encodeCANID(nodeNumber, CAN_ID) → {String}

opCode 75

Parameters:

Name	Type	Description
`nodeNumber`	int	number 0 to 65535
`CAN_ID`	int	number 0 to 255

Source:

cbuslibrary.js, line 2924

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<75><nodeNumber hi><nodeNumber lo><CAN_ID>

Type: String

encodeCMDERR(nodeNumber, errorNumber) → {String}

opCode 6F

Parameters:

Name	Type	Description
`nodeNumber`	int	number 0 to 65535
`errorNumber`	int	number 0 to 255

Source:

cbuslibrary.js, line 2768

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<6F><nodeNumber hi><nodeNumber lo><errorNumber>

Type: String

encodeDBG1(status) → {String}

opCode 30

Parameters:

Name	Type	Description
`status`	int	number 0 to 255

Source:

cbuslibrary.js, line 1949

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=2><CANID>]<30><status>

Type: String

encodeDDES(deviceNumber, data1, data2, data3, data4, data5) → {String}

opCode FA

Parameters:

Name	Type	Description
`deviceNumber`	int	0 to 65535
`data1`	int	0 to 255
`data2`	int	0 to 255
`data3`	int	0 to 255
`data4`	int	0 to 255
`data5`	int	0 to 255

Source:

cbuslibrary.js, line 5195

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<FA><deviceNumber hi><deviceNumber lo><data1><data2><data3><data4><data5>

Type: String

encodeDDRS(deviceNumber, data1, data2, data3, data4, data5) → {String}

opCode FB

Parameters:

Name	Type	Description
`deviceNumber`	int	0 to 65535
`data1`	int	0 to 255
`data2`	int	0 to 255
`data3`	int	0 to 255
`data4`	int	0 to 255
`data5`	int	0 to 255

Source:

cbuslibrary.js, line 5239

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<FB><deviceNumber hi><deviceNumber lo><data1><data2><data3><data4><data5>

Type: String

encodeDFLG(session, flags) → {String}

opCode 48

Parameters:

Name	Type	Description
`session`	int	number 0 to 255
`flags`	int	bits 0 to 7

Source:

cbuslibrary.js, line 2201

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=2><CANID>]<48><session><flags>

Type: String

encodeDFNOF(session, functionNumber) → {String}

opCode 4A

Parameters:

Name	Type	Description
`session`	int	number 0 to 255
`functionNumber`	int	0 to 255

Source:

cbuslibrary.js, line 2253

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=2><CANID>]<4A><session><functionNumber>

Type: String

encodeDFNON(session, functionNumber) → {String}

opCode 49

Parameters:

Name	Type	Description
`session`	int	number 0 to 255
`functionNumber`	int	0 to 255

Source:

cbuslibrary.js, line 2227

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=2><CANID>]<49><session><functionNumber>

Type: String

encodeDFUN(session, Fn1, Fn2) → {String}

opCode 60

Parameters:

Name	Type	Description
`session`	int	number 0 to 255
`Fn1`	int	number 0 to 255
`Fn2`	int	number 0 to 255

Source:

cbuslibrary.js, line 2685

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=2><CANID>]<60><session><Fn1><Fn2>

Type: String

encodeDKEEP(session) → {String}

opCode 23

Parameters:

Name	Type	Description
`session`	int	number 0 to 255

Source:

cbuslibrary.js, line 1926

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=2><CANID>]<23><session>

Type: String

encodeDSPD(session, speed, direction) → {String}

opCode 47

Parameters:

Name	Type	Description
`session`	int	number 0 to 255
`speed`	int	number 0 to 127
`direction`	string	'Reverse' or 'Forward' (defaults to 'Forward' if string not matching 'Reverse')

Source:

cbuslibrary.js, line 2175

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=2><CANID>]<46><session><speed/dir>

Type: String

encodeENRSP(nodeNumber, eventIdentifier, eventIndex) → {String}

opCode F2

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`eventIdentifier`	string	8 digit hexadecimal string, with leading zero's
`eventIndex`	int	0 to 255

Source:

cbuslibrary.js, line 4877

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<F2><nodeNumber hi><nodeNumber lo><eventName char 3><eventName char 2><eventName char 1><eventName char 0><eventIndex>

Type: String

encodeENUM(nodeNumber) → {String}

opCode 5D

Parameters:

Name	Type	Description
`nodeNumber`	int	number 0 to 65535

Source:

cbuslibrary.js, line 2631

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<5D><nodeNumber hi><nodeNumber lo>

Type: String

encodeERR(data1, data2, errorNumber) → {String}

opCode 63

Parameters:

Name	Type	Description
`data1`	int	number 0 to 255
`data2`	int	number 0 to 255
`errorNumber`	int	number 0 to 255

Source:

cbuslibrary.js, line 2742

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=2><CANID>]<63><data1><data2><errorNumber>

Type: String

encodeESTOP() → {String}

opCode 06

Source:

cbuslibrary.js, line 1668

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=1><CANID>]<06>

Type: String

encodeEVANS(nodeNumber, eventNumber, eventVariableIndex, eventVariableValue) → {String}

opCode D3

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`eventNumber`	int	0 to 65535
`eventVariableIndex`	int	0 to 255
`eventVariableValue`	int	0 to 255

Source:

cbuslibrary.js, line 4321

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<D3><nodeNumber hi><nodeNumber lo><eventNumber hi><eventNumber lo><eventVariableIndex><eventVariableValue>

Type: String

encodeEVLRN(nodeNumber, eventNumber, eventVariableIndex, eventVariableValue) → {String}

opCode D2

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`eventNumber`	int	0 to 65535
`eventVariableIndex`	int	0 to 255
`eventVariableValue`	int	0 to 255

Source:

cbuslibrary.js, line 4288

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<D2><nodeNumber hi><nodeNumber lo><eventNumber hi><eventNumber lo><eventVariableIndex><eventVariableValue>

Type: String

encodeEVLRNI(nodeNumber, eventNumber, eventNumberIndex, eventVariableIndex, eventVariableValue) → {String}

opCode F5

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`eventNumber`	int	0 to 65535
`eventNumberIndex`	int	0 to 255
`eventVariableIndex`	int	0 to 255
`eventVariableValue`	int	0 to 255

Source:

cbuslibrary.js, line 4990

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<F5><nodeNumber hi><nodeNumber lo><eventNumber hi><eventNumber lo><eventNumberIndex><eventVariableIndex><deventVariableValue>

Type: String

encodeEVNLF(nodeNumber, EVSPC) → {String}

opCode 70

Parameters:

Name	Type	Description
`nodeNumber`	int	number 0 to 65535
`EVSPC`	int	number 0 to 255

Source:

cbuslibrary.js, line 2794

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<70><nodeNumber hi><nodeNumber lo><EVNLF>

Type: String

encodeEVULN(nodeNumber, eventNumber) → {String}

opCode 95

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`eventNumber`	int	0 to 65535

Source:

cbuslibrary.js, line 3268

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<95><nodeNumber hi><nodeNumber lo><eventNumber hi><eventNumber lo>

Type: String

encodeEXTC(Ext_OPC) → {String}

opCode 3F

Parameters:

Name	Type	Description
`Ext_OPC`	int	number 0 to 255

Source:

cbuslibrary.js, line 1972

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<3F><Ext_OPC>

Type: String

encodeEXTC1(Ext_OPC, byte1) → {String}

opCode 5C

Parameters:

Name	Type	Description
`Ext_OPC`	int	number 0 to 255
`byte1`	int	number 0 to 255

Source:

cbuslibrary.js, line 2656

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<5C><Ext_OPC><byte1>

Type: String

encodeEXTC2(Ext_OPC, byte1, byte2) → {String}

opCode 7F

Parameters:

Name	Type	Description
`Ext_OPC`	int	number 0 to 255
`byte1`	int	number 0 to 255
`byte2`	int	number 0 to 255

Source:

cbuslibrary.js, line 2953

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<7F><Ext_OPC><byte1><byte2>

Type: String

encodeEXTC3(Ext_OPC, byte1, byte2, byte3) → {String}

opCode 9F

Parameters:

Name	Type	Description
`Ext_OPC`	int	0 to 255
`byte1`	int	0 to 255
`byte2`	int	0 to 255
`byte3`	int	0 to 255

Source:

cbuslibrary.js, line 3556

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<9F><Ext_OPC><byte1><byte2><byte3>

Type: String

encodeEXTC4(Ext_OPC, byte1, byte2, byte3, byte4) → {String}

opCode BF

Parameters:

Name	Type	Description
`Ext_OPC`	int	0 to 255
`byte1`	int	0 to 255
`byte2`	int	0 to 255
`byte3`	int	0 to 255
`byte4`	int	0 to 255

Source:

cbuslibrary.js, line 4044

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<BF><Ext_OPC><byte1><byte2><byte3><byte4>

Type: String

encodeEXTC5(Ext_OPC, byte1, byte2, byte3, byte4, byte5) → {String}

opCode DF

Parameters:

Name	Type	Description
`Ext_OPC`	int	0 to 255
`byte1`	int	0 to 255
`byte2`	int	0 to 255
`byte3`	int	0 to 255
`byte4`	int	0 to 255
`byte5`	int	0 to 255

Source:

cbuslibrary.js, line 4563

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<DF><Ext_OPC><byte1><byte2><byte3><byte4><byte5>

Type: String

encodeEXTC6(Ext_OPC, data1, data2, data3, data4, data5, data6) → {String}

opCode FF

Parameters:

Name	Type	Description
`Ext_OPC`	int	0 to 255
`data1`	int	0 to 255
`data2`	int	0 to 255
`data3`	int	0 to 255
`data4`	int	0 to 255
`data5`	int	0 to 255
`data6`	int	0 to 255

Source:

cbuslibrary.js, line 5361

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<FF><Ext_OPC><data1><data2><data3><data4><data5><data6>

Type: String

encodeFCLK(minutes, hours, day, month, div, mday, temperature) → {String}

opCode CF

Parameters:

Name	Type	Description
`minutes`	int	0 to 59
`hours`	int	0 to 23
`day`	int	of week 1 to 7 (1=Sun, 2=Mon etc)
`month`	int	1 to 12 (1=Jan, 2=Feb etc)
`div`	int	Set to 0 for freeze, 1 for real time
`mday`	int	day of the month 1-31
`temperature`	int	twos complement -127 to +127

Source:

cbuslibrary.js, line 4178

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<CF><mins><hrs><wdmon><div><mday><temp>

Type: String

encodeGLOC(address, flags) → {String}

opCode 61

Parameters:

Name	Type	Description
`address`	int	number 0 to 65535
`flags`	int	number 0 to 255

Source:

cbuslibrary.js, line 2712

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=2><CANID>]<61><address><Flags>

Type: String

encodeGSTOP() → {String}

opCode 12

Source:

cbuslibrary.js, line 1857

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=0><CANID>]<12>

Type: String

encodeHEARTB(nodeNumber, SequenceCount, StatusByte1, StatusByte2) → {String}

opCode AB

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`SequenceCount`	int	0 to 255
`StatusByte1`	int	2 to 255
`StatusByte2`	int	3 to 255

Source:

cbuslibrary.js, line 3662

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=2><CANID>]<AB><nodeNumber hi><nodeNumber lo><SequenceCnt#><StatusByte1#>&StatusByte2>

Type: String

encodeHLT() → {String}

opCode 02

Source:

cbuslibrary.js, line 1584

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=0><CANID>]<02>

Type: String

encodeKCON(session, consistAddress) → {String}

opCode 46

Parameters:

Name	Type	Description
`session`	int	number 0 to 255
`consistAddress`	int	number 0 to 255

Source:

cbuslibrary.js, line 2144

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=2><CANID>]<46><session><consistAddress>

Type: String

encodeKLOC(session) → {String}

opCode 21

Parameters:

Name	Type	Description
`session`	int	number 0 to 255

Source:

cbuslibrary.js, line 1880

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=2><CANID>]<21><session>

Type: String

encodeNAK() → {String}

opCode 01

Source:

cbuslibrary.js, line 1563

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=2><CANID>]<01>

Type: String

encodeNAME(name) → {String}

opCode E2

Parameters:

Name	Type	Description
`name`	string	0 to 7 ASCII characters (will be right padded with spaces to 7 characters)

Source:

cbuslibrary.js, line 4683

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=2><CANID>]<E2><char1><char2><char3><char4><char5><char6><char7>

Type: String

encodeNENRD(nodeNumber, eventIndex) → {String}

opCode 72

Parameters:

Name	Type	Description
`nodeNumber`	int	number 0 to 65535
`eventIndex`	int	number 0 to 255

Source:

cbuslibrary.js, line 2846

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<72><nodeNumber hi><nodeNumber lo><eventIndex>

Type: String

encodeNERD(nodeNumber) → {String}

opCode 57

Parameters:

Name	Type	Description
`nodeNumber`	int	number 0 to 65535

Source:

cbuslibrary.js, line 2492

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<57><nodeNumber hi><nodeNumber lo>

Type: String

encodeNEVAL(nodeNumber, eventIndex, eventVariableIndex, eventVariableValue) → {String}

opCode B5

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`eventIndex`	int	0 to 255
`eventVariableIndex`	int	0 to 255
`eventVariableValue`	int	0 to 255

Source:

cbuslibrary.js, line 3851

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<B5><nodeNumber hi><nodeNumber lo><eventIndex><eventVariableIndex><eventVariableValue>

Type: String

encodeNNACK(nodeNumber) → {String}

opCode 52

Parameters:

Name	Type	Description
`nodeNumber`	int	number 0 to 65535

Source:

cbuslibrary.js, line 2372

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<52><nodeNumber hi><nodeNumber lo>

Type: String

encodeNNCLR(nodeNumber) → {String}

opCode 55

Parameters:

Name	Type	Description
`nodeNumber`	int	number 0 to 65535

Source:

cbuslibrary.js, line 2445

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<55><nodeNumber hi><nodeNumber lo>

Type: String

encodeNNEVN(nodeNumber) → {String}

opCode 56

Parameters:

Name	Type	Description
`nodeNumber`	int	number 0 to 65535

Source:

cbuslibrary.js, line 2468

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<56><nodeNumber hi><nodeNumber lo>

Type: String

encodeNNLRN(nodeNumber) → {String}

opCode 53

Parameters:

Name	Type	Description
`nodeNumber`	int	number 0 to 65535

Source:

cbuslibrary.js, line 2397

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<53><nodeNumber hi><nodeNumber lo>

Type: String

encodeNNREL(nodeNumber) → {String}

opCode 51

Parameters:

Name	Type	Description
`nodeNumber`	int	number 0 to 65535

Source:

cbuslibrary.js, line 2349

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<51><nodeNumber hi><nodeNumber lo>

Type: String

encodeNNRSM(session, status) → {String}

opCode 4F

Parameters:

Name	Type	Description
`session`	int	number 0 to 255
`status`	int	0 to 255

Source:

cbuslibrary.js, line 2303

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<4C><nodeNumber>

Type: String

encodeNNULN(nodeNumber) → {String}

opCode 54

Parameters:

Name	Type	Description
`nodeNumber`	int	number 0 to 65535

Source:

cbuslibrary.js, line 2422

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<54><nodeNumber hi><nodeNumber lo>

Type: String

encodeNUMEV(nodeNumber, eventCount) → {String}

opCode 74

Parameters:

Name	Type	Description
`nodeNumber`	int	number 0 to 65535
`eventCount`	int	number 0 to 255

Source:

cbuslibrary.js, line 2898

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<74><nodeNumber hi><nodeNumber lo><eventCount>

Type: String

encodeNVANS(nodeNumber, nodeVariableIndex, nodeVariableValue) → {String}

opCode 97

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`nodeVariableIndex`	int	0 to 255
`nodeVariableValue`	int	0 to 255

Source:

cbuslibrary.js, line 3326

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<97><nodeNumber hi><nodeNumber lo><nodeVariableIndex><nodeVariableValue>

Type: String

encodeNVRD(nodeNumber, nodeVariableIndex) → {String}

opCode 71

Parameters:

Name	Type	Description
`nodeNumber`	int	number 0 to 65535
`nodeVariableIndex`	int	number 0 to 255

Source:

cbuslibrary.js, line 2820

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<71><nodeNumber hi><nodeNumber lo><nodeVariableIndex>

Type: String

encodeNVSET(nodeNumber, nodeVariableIndex, nodeVariableValue) → {String}

opCode 96

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`nodeVariableIndex`	int	0 to 255
`nodeVariableValue`	int	0 to 255

Source:

cbuslibrary.js, line 3297

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<96><nodeNumber hi><nodeNumber lo><nodeVariableIndex><nodeVariableValue>

Type: String

encodePARAMS(param1, param2, param3, param4, param5, param6, param7) → {String}

opCode EF

Parameters:

Name	Type	Description
`param1`	int	0 to 255
`param2`	int	0 to 255
`param3`	int	0 to 255
`param4`	int	0 to 255
`param5`	int	0 to 255
`param6`	int	0 to 255
`param7`	int	0 to 255

Source:

cbuslibrary.js, line 4768

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<EF><param1><param2><param3><param4><param5><param6><param7>

Type: String

encodePARAN(nodeNumber, parameterIndex, parameterValue) → {String}

opCode 9B

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`parameterIndex`	int	0 to 255
`parameterValue`	int	0 to 255

Source:

cbuslibrary.js, line 3439

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<9B><nodeNumber hi><nodeNumber lo><parameterIndex><parameterValue>

Type: String

encodePCON(session, consistAddress) → {String}

opCode 45

Parameters:

Name	Type	Description
`session`	int	number 0 to 255
`consistAddress`	int	number 0 to 255

Source:

cbuslibrary.js, line 2119

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=2><CANID>]<45><session><consistAddress>

Type: String

encodePCVS(session, CV, value) → {String}

opCode 85

Parameters:

Name	Type	Description
`session`	int	number 0 to 255
`CV`	int	number 0 to 65535
`value`	int	number 0 to 255

Source:

cbuslibrary.js, line 3101

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=2><CANID>]<85><session><CV hi><CV lo><value>

Type: String

encodePLOC(repetitions, session, address, speed, direction, Fn1, Fn2, Fn3) → {String}

opCode E1

Parameters:

Name	Type	Description
`repetitions`	int	0 to 255
`session`	int	0 to 255
`address`	int	0 to 65535
`speed`	int	number 0 to 127
`direction`	string	'Reverse' or 'Forward' (defaults to 'Forward' if string not matching 'Reverse')
`Fn1`	int	0 to 255
`Fn2`	int	0 to 255
`Fn3`	int	0 to 255

Source:

cbuslibrary.js, line 4659

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=2><CANID>]<E1><repetitions><session><address hi><address lo><Speed/Dir><Fn1><Fn2><Fn3>

Type: String

encodePNN(nodeNumber, manufacturerId, moduleId, flags) → {String}

opCode B6

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`manufacturerId`	int	0 to 255
`moduleId`	int	0 to 255
`flags`	int	0 to 255

Source:

cbuslibrary.js, line 3883

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<B6><nodeNumber hi><nodeNumber lo><manufacturerId><moduleId><flags>

Type: String

encodeQCON(conID, index) → {String}

opCode 41

Parameters:

Name	Type	Description
`conID`	int	number 0 to 255
`index`	int	number 0 to 255

Source:

cbuslibrary.js, line 2021

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=2><CANID>]<41><ConID><index>

Type: String

encodeQCVS(session, CV, mode) → {String}

opCode 83

Parameters:

Name	Type	Description
`session`	int	number 0 to 255
`CV`	int	number 0 to 65535
`mode`	int	number 0 to 255

Source:

cbuslibrary.js, line 3072

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=2><CANID>]<83><session><CV hi><CV lo><Mode>

Type: String

encodeQLOC(session) → {String}

opCode 22

Parameters:

Name	Type	Description
`session`	int	number 0 to 255

Source:

cbuslibrary.js, line 1903

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=2><CANID>]<22><session>

Type: String

encodeQNN() → {String}

opCode 0D

Source:

cbuslibrary.js, line 1794

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<0D>

Type: String

encodeRDCC3(repetitions, byte0, byte1, byte2) → {String}

opCode 80

Parameters:

Name	Type	Description
`repetitions`	int	number 0 to 255
`byte0`	int	number 0 to 255
`byte1`	int	number 0 to 255
`byte2`	int	number 0 to 255

Source:

cbuslibrary.js, line 2985

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=2><CANID>]<80>&repetitions><byte0><byte1><byte2>

Type: String

encodeRDCC4(repetitions, byte0, byte1, byte2, byte4) → {String}

opCode A0

Parameters:

Name	Type	Description
`repetitions`	int	0 to 255
`byte0`	int	0 to 255
`byte1`	int	0 to 255
`byte2`	int	0 to 255
`byte4`	int	0 to 255

Source:

cbuslibrary.js, line 3591

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=2><CANID>]<A0><Ext_OPC><byte0><byte1><byte2><byte3>

Type: String

encodeRDCC5(repetitions, byte0, byte1, byte2, byte3, byte4) → {String}

opCode C0

Parameters:

Name	Type	Description
`repetitions`	int	0 to 255
`byte0`	int	0 to 255
`byte1`	int	0 to 255
`byte2`	int	0 to 255
`byte3`	int	0 to 255
`byte4`	int	0 to 255

Source:

cbuslibrary.js, line 4086

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=2><CANID>]<C0><Ext_OPC><byte0><byte1><byte2><byte3><byte4>

Type: String

encodeRDCC6(repetitions, byte0, byte1, byte2, byte3, byte4, byte5) → {String}

opCode E0

Parameters:

Name	Type	Description
`repetitions`	int	0 to 255
`byte0`	int	0 to 255
`byte1`	int	0 to 255
`byte2`	int	0 to 255
`byte3`	int	0 to 255
`byte4`	int	0 to 255
`byte5`	int	0 to 255

Source:

cbuslibrary.js, line 4609

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=2><CANID>]<E0><repetitions><byte0><byte1><byte2><byte3><byte4><byte5>

Type: String

encodeREQEV(nodeNumber, eventNumber, eventVariableIndex) → {String}

opCode B2

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`eventNumber`	int	0 to 65535
`eventVariableIndex`	int	0 to 255

Source:

cbuslibrary.js, line 3757

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<B2><nodeNumber hi><nodeNumber lo><eventNumber hi><eventNumber lo><eventVariableIndex>

Type: String

encodeRESTP() → {String}

opCode 0A

Source:

cbuslibrary.js, line 1752

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=0><CANID>]<0A>

Type: String

encodeREVAL(nodeNumber, eventIndex, eventVariableIndex) → {String}

opCode 9C

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`eventIndex`	int	0 to 255
`eventVariableIndex`	int	0 to 255

Source:

cbuslibrary.js, line 3468

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<9C><nodeNumber hi><nodeNumber lo><eventIndex><eventVariableIndex>

Type: String

encodeRLOC(address) → {String}

opCode 40

Parameters:

Name	Type	Description
`address`	int	number 0 to 65535

Source:

cbuslibrary.js, line 1996

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=2><CANID>]<40><address hi><address lo>

Type: String

encodeRQDAT(nodeNumber) → {String}

opCode 5A

Parameters:

Name	Type	Description
`nodeNumber`	int	number 0 to 65535

Source:

cbuslibrary.js, line 2562

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<5A><nodeNumber hi><nodeNumber lo>

Type: String

encodeRQDDS(nodeNumber) → {String}

opCode 5B

Parameters:

Name	Type	Description
`nodeNumber`	int	number 0 to 65535

Source:

cbuslibrary.js, line 2585

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<5B><nodeNumber hi><nodeNumber lo>

Type: String

encodeRQEVN(nodeNumber) → {String}

opCode 58

Parameters:

Name	Type	Description
`nodeNumber`	int	number 0 to 65535

Source:

cbuslibrary.js, line 2516

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<58><nodeNumber hi><nodeNumber lo>

Type: String

encodeRQMN() → {String}

opCode 11

Source:

cbuslibrary.js, line 1836

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=2><CANID>]<11>

Type: String

encodeRQNN(nodeNumber) → {String}

opCode 50

Parameters:

Name	Type	Description
`nodeNumber`	int	number 0 to 65535

Source:

cbuslibrary.js, line 2326

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<50><nodeNumber hi><nodeNumber lo>

Type: String

encodeRQNP() → {String}

opCode 10

Source:

cbuslibrary.js, line 1815

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<10>

Type: String

encodeRQNPN(nodeNumber, parameterIndex) → {String}

opCode 73

Parameters:

Name	Type	Description
`nodeNumber`	int	number 0 to 65535
`parameterIndex`	int	number 0 to 255

Source:

cbuslibrary.js, line 2872

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<73><nodeNumber hi><nodeNumber lo><parameterIndex>

Type: String

encodeRSTAT() → {String}

opCode 0C

Source:

cbuslibrary.js, line 1773

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=2><CANID>]<0C>

Type: String

encodeRTOF() → {String}

opCode 08

Source:

cbuslibrary.js, line 1710

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=0><CANID>]<08>

Type: String

encodeRTON() → {String}

opCode 09

Source:

cbuslibrary.js, line 1731

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=0><CANID>]<09>

Type: String

encodeSNN(nodeNumber) → {String}

opCode 42

Parameters:

Name	Type	Description
`nodeNumber`	int	number 0 to 65535

Source:

cbuslibrary.js, line 2044

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<42><nodeNumber hi><nodeNumber lo>

Type: String

encodeSSTAT(session, status) → {String}

opCode 4C

Parameters:

Name	Type	Description
`session`	int	number 0 to 255
`status`	int	0 to 255

Source:

cbuslibrary.js, line 2279

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<4C><session><status>

Type: String

encodeStandardMessage(message) → {Object}

encode a standard CBUS message
This will encode a 11 bit ID CBUS message from a supplied JSON object into a 'grid connect' ascii format
The supplied JSON must include the mnemonic for the opcode, and any necessary parameters for that specific opcode
If the correct JSON properties for the parameters for the opcode are not present, an exception will be thrown
The JSON properties shared by both encode() & decode() are identical - however note decode() may return more properties than encode() requires

Parameters:

Name	Type	Description
`message`	Object	CBUS message properties as a JSON object - content dependant on specific CBUS opcode, but must always contain 'mnemonic'

Source:

cbuslibrary.js, line 684

Returns:

returns the original input JSON object with the resultant encoded CBUS message added using the 'encoded' property

Type: Object

encodeSTAT(nodeNumber, CS, flags, major, minor, build) → {String}

opCode E3

Parameters:

Name	Type	Description
`nodeNumber`	int	0 to 65535
`CS`	int	0 to 255
`flags`	int	0 to 255
`major`	int	0 to 255
`minor`	int	0 to 255
`build`	int	0 to 255

Source:

cbuslibrary.js, line 4722

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=2><CANID>]<E3><nodeNumber hi><nodeNumber lo><CS><flags><major><minor><build>

Type: String

encodeSTMOD(session, modeByte) → {String}

opCode 44

Parameters:

Name	Type	Description
`session`	int	number 0 to 255
`modeByte`	int	number 0 to 255

Source:

cbuslibrary.js, line 2094

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=2><CANID>]<44><session><modeByte>

Type: String

encodeTOF() → {String}

opCode 04

Source:

cbuslibrary.js, line 1626

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=1><CANID>]<04>

Type: String

encodeTON() → {String}

opCode 05

Source:

cbuslibrary.js, line 1647

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=1><CANID>]<05>

Type: String

encodeWCVB(session, CV, value) → {String}

opCode 83

Parameters:

Name	Type	Description
`session`	int	number 0 to 255
`CV`	int	number 0 to 65535
`value`	int	number 0 to 255

Source:

cbuslibrary.js, line 3043

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=2><CANID>]<83><session><CV hi><CV lo><value>

Type: String

encodeWCVO(session, CV, value) → {String}

opCode 82

Parameters:

Name	Type	Description
`session`	int	number 0 to 255
`CV`	int	number 0 to 65535
`value`	int	number 0 to 255

Source:

cbuslibrary.js, line 3014

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=2><CANID>]<82><session><CV hi><CV lo><value>

Type: String

encodeWCVOA(session, CV, mode, value) → {String}

opCode C1

Parameters:

Name	Type	Description
`session`	int	number 0 to 255
`CV`	int	number 0 to 65535
`mode`	int	number 0 to 255
`value`	int	number 0 to 255

Source:

cbuslibrary.js, line 4123

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=2><CANID>]<C1><session><CV hi><CV lo><mode><value>

Type: String

encodeWCVS(session, CV, mode, value) → {String}

opCode A2

Parameters:

Name	Type	Description
`session`	int	0 to 255
`CV`	int	1 to 65535
`mode`	int	2 to 255
`value`	int	3 to 255

Source:

cbuslibrary.js, line 3627

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=2><CANID>]<A2>&session><High CV#><Low CV#><mode><value3>

Type: String

encodeWRACK(nodeNumber) → {String}

opCode 59

Parameters:

Name	Type	Description
`nodeNumber`	int	number 0 to 65535

Source:

cbuslibrary.js, line 2539

Returns:

CBUS message encoded as a 'Grid Connect' ASCII string
Format: [<MjPri><MinPri=3><CANID>]<59><nodeNumber hi><nodeNumber lo>

Type: String

getCanHeader() → {String}

gets the can header

Source:

cbuslibrary.js, line 86

Returns:

Returns changeable CAN header parameters as JSON structure

Type: String

Example

{
  'MjPri': 2,
  'CAN_ID': 60,
}

setCanHeader(MjPri, CAN_ID)

setCanHeader

Parameters:

Name	Type	Description
`MjPri`	int	Major priority, two bit number 0 - 3 (3 is allowed, unlike previous assumption)
`CAN_ID`	int	7 bit number, 0 to 127

Source:

cbuslibrary.js, line 94