Class MBoxClient

Hierarchy

MBoxClient

Constructors

constructor

new MBoxClient(host): MBoxClient
Parameters
- host: string
Returns MBoxClient
- Defined in index.ts:37

Properties

`Private` deviceErrorListener

deviceErrorListener: null | ((error) => void) = null

Type declaration

- (error): void
- Parameters
  - error: {
    error_code: number;
    }
    - error_code: number
  Returns void

`Private` enrichedSlaves

enrichedSlaves: SlaveEnriched[] = []

`Private` host

host: string

`Private` initializedCallbacks

initializedCallbacks: (() => void)[] = []

Type declaration

- (): void
- Returns void

manifest

manifest: null | Manifest = null

`Private` slavesUpdated

slavesUpdated: boolean = false

`Private` statusUpdateListener

statusUpdateListener: null | ((status) => void) = null

Type declaration

- (status): void
- Parameters
  - status: DeviceStatus
  Returns void

`Private` webSocketClient

webSocketClient: WebSocketClient

`Private` wifiScanCompleteListener

wifiScanCompleteListener: null | ((__namedParameters) => void) = null

Type declaration

- (__namedParameters): void
- Parameters
  - __namedParameters: {
    networks: WiFiNetwork[];
    }
    - networks: WiFiNetwork[]
  Returns void

Methods

addSlave

addSlave(slave): Promise<void>
Parameters
- slave: SlaveCreate
Returns Promise<void>
- Defined in index.ts:273

changePassword

changePassword(newPassword): Promise<void>
Parameters
- newPassword: Password
Returns Promise<void>
- Defined in index.ts:305

`Private` enrichReceivedSlaves

enrichReceivedSlaves(slaves): SlaveEnriched[]
Parameters
- slaves: Slave[]
Returns SlaveEnriched[]
- Defined in index.ts:161

`Private` enrichSlave

enrichSlave(slave): SlaveEnriched
Parameters
- slave: Slave
Returns SlaveEnriched
- Defined in index.ts:75

factoryReset

factoryReset(): Promise<void>
Resets the device to factory config.

Returns Promise<void>
- Defined in index.ts:332

`Private` findSlaveById

findSlaveById(slaves, slaveId): null | SlaveEnriched
Parameters
- slaves: SlaveEnriched[]
- slaveId: number
Returns null | SlaveEnriched
- Defined in index.ts:169

getConfig

getConfig(): Promise<DeviceConfig>
Returns Promise<DeviceConfig>
- Defined in index.ts:233

getInfo

getInfo(): Promise<DeviceInfo>
Returns Promise<DeviceInfo>
- Defined in index.ts:213

getSlave

getSlave(slaveId): Promise<null | SlaveEnriched>
Parameters
- slaveId: number
Returns Promise<null | SlaveEnriched>
- Defined in index.ts:243

getSlaves

getSlaves(): Promise<[] | SlaveEnriched[]>
Returns Promise<[] | SlaveEnriched[]>
- Defined in index.ts:259

getStatus

getStatus(): Promise<DeviceStatus>
Returns Promise<DeviceStatus>
- Defined in index.ts:218

`Private` handleError

handleError(error): void
Parameters
- error: Error
Returns void
- Defined in index.ts:173

`Private` handleSlaveListUpdate

handleSlaveListUpdate(data): Promise<void>
Parameters
- data: Record<string, any>
Returns Promise<void>
- Defined in index.ts:51

init

init(): Promise<void>
Returns Promise<void>
- Defined in index.ts:187

`Private` initializeEventHandlers

initializeEventHandlers(): void
Returns void
- Defined in index.ts:138

`Private` loadManifest

loadManifest(): Promise<Manifest>
Returns Promise<Manifest>
- Defined in index.ts:65

locate

locate(): Promise<void>
Flash the locate LED.

Returns Promise<void>
A promise that resolves when the operation is complete.
- Defined in index.ts:208

`Private` notifyInitialized

notifyInitialized(): void
Returns void
- Defined in index.ts:132

offDeviceError

offDeviceError(): void
Unsubscribes from device error messages.

Returns void
- Defined in index.ts:397

offStatusUpdate

offStatusUpdate(): void
Unsubscribes from status updates.

Returns void
- Defined in index.ts:375

offWiFiScanComplete

offWiFiScanComplete(): void
Unsubscribes from WiFi Scan Complete.

Returns void
- Defined in index.ts:431

onDeviceError

onDeviceError(cb): void
Subscribes to device error messages.
Parameters
- cb: ((error) => void)
  
  Callback function to execute when an error message is received.
  - - (error): void
    - Parameters
      
      error: {
      error_code: number;
      }
      
      error_code: number
      
      Returns void
Returns void
- Defined in index.ts:385

onInitialized

onInitialized(cb): void
Subscribes a callback function to be executed when the client is initialized.
Parameters
- cb: (() => void)
  
  The callback function to execute upon initialization.
  - - (): void
    - Returns void
Returns void
- Defined in index.ts:342

onSlavesUpdate

onSlavesUpdate(cb): void
Subscribes to updates to the list of slave devices.
Parameters
- cb: Function
  
  Callback function to execute when the list of slave devices is updated.
Returns void
- Defined in index.ts:407

onStatusUpdate

onStatusUpdate(cb): void
Subscribes to status updates.
Parameters
- cb: ((status) => void)
  
  Callback function to execute when a status update is received.
  - - (status): void
    - Parameters
      
      status: DeviceStatus
      
      Returns void
Returns void
- Defined in index.ts:363

onWiFiScanComplete

onWiFiScanComplete(cb): void
Subscribes to status updates.
Parameters
- cb: ((networks) => void)
  
  Callback function to execute when Wi-Fi scan completed.
  - - (networks): void
    - Parameters
      
      networks: WiFiNetwork[]
      
      Returns void
Returns void
- Defined in index.ts:419

reboot

reboot(): Promise<void>
Reboots the device.

Returns Promise<void>
- Defined in index.ts:323

reload

reload(): Promise<void>
Reloads the device.

Returns Promise<void>
- Defined in index.ts:314

removeSlave

removeSlave(id): Promise<void>
Parameters
- id: number
Returns Promise<void>
- Defined in index.ts:300

`Private` request

request<T>(message): Promise<T>
Type Parameters
- T
Parameters
- message: any
Returns Promise<T>
- Defined in index.ts:41

runSlaveFunction

runSlaveFunction(slaveId, command): Promise<void>
Parameters
- slaveId: number
- command: FunctionOptionCommand
Returns Promise<void>
- Defined in index.ts:346

setConfig

setConfig(data): Promise<DeviceConfig>
Parameters
- data: DeviceConfig
Returns Promise<DeviceConfig>
- Defined in index.ts:238

setWiFi

setWiFi(network): Promise<void>
Parameters
- network: any
Returns Promise<void>
- Defined in index.ts:228

`Private` waitForSlaveListResponse

waitForSlaveListResponse(): Promise<any>
Returns Promise<any>
- Defined in index.ts:142

wifiScan

wifiScan(): Promise<void>
Returns Promise<void>
- Defined in index.ts:223

Generated using TypeDoc