Class Local

Hierarchy

Local

Constructors

constructor

new Local(username: string, password: string, ip: string, version?: 2 | 3, interval?: number): Local

- Defined in dorita980.d.ts:11
The library send commands directly over wifi to your robot. You dont need an internet connection.

Parameters
- username: string
  
  your roomba's blid
- password: string
  
  your roomba's password
- ip: string
  
  your roomba's ip address
- Optional version: 2 | 3
  
  (optional) your roomba's protocol version (1-3, defaults to 2)
- Optional interval: number
  
  (optional) interval in miliseconds to emith mission event (defaults to 800ms)
Returns Local

Methods

clean

clean(): Promise<{ ok: null }>

- Defined in dorita980.d.ts:51
Returns Promise<{ ok: null }>

cleanRoom

cleanRoom(callback?: (args: any) => Promise<{ ok: null }>): Local

- Defined in dorita980.d.ts:52
Parameters
- Optional callback: (args: any) => Promise<{ ok: null }>
  - - (args: any): Promise<{ ok: null }>
    - Parameters
      - args: any
      Returns Promise<{ ok: null }>
Returns Local

dock

dock(): Promise<{ ok: null }>

- Defined in dorita980.d.ts:56
Returns Promise<{ ok: null }>

end

end(): void

- Defined in dorita980.d.ts:34
Returns void

evac

evac(): Promise<{ ok: null }>

- Defined in dorita980.d.ts:58
Returns Promise<{ ok: null }>

find

find(): Promise<{ ok: null }>

- Defined in dorita980.d.ts:57
Returns Promise<{ ok: null }>

getBasicMission

getBasicMission(waitForFields?: string[]): Local

- Defined in dorita980.d.ts:45
Parameters
- Optional waitForFields: string[]
Returns Local

getBbrun

getBbrun(): Promise<fullRobotState>

- Defined in dorita980.d.ts:37
Returns Promise<fullRobotState>

getCloudConfig

getCloudConfig(): Promise<fullRobotState>

- Defined in dorita980.d.ts:48
Returns Promise<fullRobotState>

getLangs

getLangs(): Promise<fullRobotState>

- Defined in dorita980.d.ts:38
Returns Promise<fullRobotState>

getMission

getMission(calwaitForFields?: string[]): Local

- Defined in dorita980.d.ts:44
Parameters
- Optional calwaitForFields: string[]
Returns Local

getPreferences

getPreferences(waitForFields?: string[]): Local

- Defined in dorita980.d.ts:42
Parameters
- Optional waitForFields: string[]
Returns Local

getRobotState

getRobotState(waitForFields?: string[]): Local

- Defined in dorita980.d.ts:43
Parameters
- Optional waitForFields: string[]
Returns Local

getSKU

getSKU(): Promise<fullRobotState>

- Defined in dorita980.d.ts:49
Returns Promise<fullRobotState>

getSys

getSys(): Promise<fullRobotState>

- Defined in dorita980.d.ts:39
Returns Promise<fullRobotState>

getTime

getTime(): Promise<fullRobotState>

- Defined in dorita980.d.ts:36
Returns Promise<fullRobotState>

getWeek

getWeek(): Promise<fullRobotState>

- Defined in dorita980.d.ts:41
Returns Promise<fullRobotState>

getWirelessConfig

getWirelessConfig(): Promise<fullRobotState>

- Defined in dorita980.d.ts:46
Returns Promise<fullRobotState>

getWirelessLastStatus

getWirelessLastStatus(): Promise<fullRobotState>

- Defined in dorita980.d.ts:40
Returns Promise<fullRobotState>

getWirelessStatus

getWirelessStatus(): Promise<fullRobotState>

- Defined in dorita980.d.ts:47
Returns Promise<fullRobotState>

on

on(event: "connect", listener: () => void): Local
on(event: "close", listener: () => void): Local
on(event: "offline", listener: () => void): Local
on(event: "update", listener: (data: Data) => void): Local
on(event: "mission", listener: (data: cleanMissionStatus) => void): Local
on(event: "state", listener: (data: unknown) => void): Local

- Defined in dorita980.d.ts:13
Emitted on successful Connection.

Parameters
- event: "connect"
- listener: () => void
  - - (): void
    - Returns void
Returns Local
- Defined in dorita980.d.ts:15
Emitted after a disconnection.

Parameters
- event: "close"
- listener: () => void
  - - (): void
    - Returns void
Returns Local
- Defined in dorita980.d.ts:17
Emitted when the client goes offline.

Parameters
- event: "offline"
- listener: () => void
  - - (): void
    - Returns void
Returns Local
- Defined in dorita980.d.ts:19
Emitted every time the Robot publishes a new message to the mqtt bus.

Parameters
- event: "update"
- listener: (data: Data) => void
  - - (data: Data): void
    - Parameters
      - data: Data
      Returns void
Returns Local
- Defined in dorita980.d.ts:21
Emitted every emitIntervalTime milliseconds with the mission data. (util for mapping in models with position reporting)

Parameters
- event: "mission"
- listener: (data: cleanMissionStatus) => void
  - - (data: cleanMissionStatus): void
    - Parameters
      - data: cleanMissionStatus
      Returns void
Returns Local
- Defined in dorita980.d.ts:26
Emitted every time the Robot publish a new message to the mqtt bus. Will print the Full robot state!

Parameters
- event: "state"
- listener: (data: unknown) => void
  - - (data: unknown): void
    - Parameters
      - data: unknown
      Returns void
Returns Local

pause

pause(): Promise<{ ok: null }>

- Defined in dorita980.d.ts:53
Returns Promise<{ ok: null }>

Private removeAllListeners

removeAllListeners(event?: string | symbol): Local

- Defined in dorita980.d.ts:31
Parameters
- Optional event: string | symbol
Returns Local

resume

resume(): Promise<{ ok: null }>

- Defined in dorita980.d.ts:55
Returns Promise<{ ok: null }>

setAlwaysFinishOff

setAlwaysFinishOff(): Promise<{ ok: null }>

- Defined in dorita980.d.ts:71
Returns Promise<{ ok: null }>

setAlwaysFinishOn

setAlwaysFinishOn(): Promise<{ ok: null }>

- Defined in dorita980.d.ts:70
Returns Promise<{ ok: null }>

setCarpetBoostAuto

setCarpetBoostAuto(): Promise<{ ok: null }>

- Defined in dorita980.d.ts:62
Returns Promise<{ ok: null }>

setCarpetBoostEco

setCarpetBoostEco(): Promise<{ ok: null }>

- Defined in dorita980.d.ts:64
Returns Promise<{ ok: null }>

setCarpetBoostPerformance

setCarpetBoostPerformance(): Promise<{ ok: null }>

- Defined in dorita980.d.ts:63
Returns Promise<{ ok: null }>

setCleaningPassesAuto

setCleaningPassesAuto(): Promise<{ ok: null }>

- Defined in dorita980.d.ts:67
Returns Promise<{ ok: null }>

setCleaningPassesOne

setCleaningPassesOne(): Promise<{ ok: null }>

- Defined in dorita980.d.ts:68
Returns Promise<{ ok: null }>

setCleaningPassesTwo

setCleaningPassesTwo(): Promise<{ ok: null }>

- Defined in dorita980.d.ts:69
Returns Promise<{ ok: null }>

setEdgeCleanOff

setEdgeCleanOff(): Promise<{ ok: null }>

- Defined in dorita980.d.ts:66
Returns Promise<{ ok: null }>

setEdgeCleanOn

setEdgeCleanOn(): Promise<{ ok: null }>

- Defined in dorita980.d.ts:65
Returns Promise<{ ok: null }>

setPreferences

setPreferences(callback?: (args: any) => Promise<{ ok: null }>): Local

- Defined in dorita980.d.ts:61
Parameters
- Optional callback: (args: any) => Promise<{ ok: null }>
  - - (args: any): Promise<{ ok: null }>
    - Parameters
      - args: any
      Returns Promise<{ ok: null }>
Returns Local

setWeek

setWeek(callback?: (args: any) => Promise<{ ok: null }>): Local

- Defined in dorita980.d.ts:60
Parameters
- Optional callback: (args: any) => Promise<{ ok: null }>
  - - (args: any): Promise<{ ok: null }>
    - Parameters
      - args: any
      Returns Promise<{ ok: null }>
Returns Local

start

start(): Promise<{ ok: null }>

- Defined in dorita980.d.ts:50
Returns Promise<{ ok: null }>

stop

stop(): Promise<{ ok: null }>

- Defined in dorita980.d.ts:54
Returns Promise<{ ok: null }>

train

train(): Promise<{ ok: null }>

- Defined in dorita980.d.ts:59
Returns Promise<{ ok: null }>

Generated using TypeDoc