api_utils

Source:

Methods

(static) analyzePacket(message_buffer) → {string}

Description:
  • Generic Analysing Encoded Received Packet Function
Source:
Parameters:
Name Type Description
message_buffer ArrayBuffer | string Encoded Message Buffer
Returns:
Type
string

(static) createPacket(message, class_message, module_id, interface_id, type_id) → {Uint8Array}

Description:
  • Generic Create Encoded Packet Function
Source:
Parameters:
Name Type Description
message Object
class_message Object
module_id number
interface_id number instruction
type_id number Message type
Returns:
Type
Uint8Array

(static) decodePacket(WS_Packet, classDecode) → {Object}

Description:
  • Execute Decoding Received Packet from the Dwarf II
Source:
Parameters:
Name Type Description
WS_Packet Uint8Array
classDecode Object Class of Message depending on the command
Returns:
Type
Object

(static) nowLocal() → {string}

Description:
  • Returns the now local time as 'yyyy-mm-dd hh:mm:ss'
Source:
Returns:
Type
string

(static) nowLocalFileName() → {string|undefined}

Description:
  • Returns the now local time as 'yyyymmddhhmmss'
Source:
Returns:
Type
string | undefined

(static) nowUTC() → {string}

Description:
  • Returns the now UTC time as 'yyyy-mm-dd hh:mm:ss'
Source:
Returns:
Type
string

(static) nowUTCFileName() → {string|undefined}

Description:
  • Returns the now UTC time as 'yyyymmddhhmmss'
Source:
Returns:
Type
string | undefined

(static) setDwarfClientID(clientID) → {boolean}

Description:
  • Set clientID value if need : defaut is "0000DAF2-0000-1000-8000-00805F9B34FB"
Source:
Parameters:
Name Type Description
clientID string
Returns:
Type
boolean

(static) setDwarfDeviceID(deviceID) → {boolean}

Description:
  • Set Dwarf deviceID value upon value return by the dwarf
Source:
Parameters:
Name Type Description
deviceID number
Returns:
Type
boolean