Class RICSystem

Hierarchy

RICSystem

Constructors

constructor

new RICSystem(ricMsgHandler: RICMsgHandler, addOnManager: RICAddOnManager): RICSystem

- Defined in RICSystem.ts:65
constructor

Parameters
- ricMsgHandler: RICMsgHandler
- addOnManager: RICAddOnManager
Returns RICSystem

Properties

Private _addOnManager

_addOnManager: RICAddOnManager

Private _calibInfo

_calibInfo: null | RICCalibInfo = null

Private _connectedAddOns

_connectedAddOns: RICHWElem[] = ...

Private _defaultWiFiHostname

_defaultWiFiHostname: string = "Marty"

Private _hwElemsExcludingAddOns

_hwElemsExcludingAddOns: RICHWElem[] = ...

Private _maxSecsToWaitForWiFiConn

_maxSecsToWaitForWiFiConn: number = 20

Private _ricFriendlyName

_ricFriendlyName: null | RICFriendlyName = null

Private _ricMsgHandler

_ricMsgHandler: RICMsgHandler

Private _ricWifiConnStatus

_ricWifiConnStatus: RICWifiConnStatus = ...

Private _systemInfo

_systemInfo: null | RICSystemInfo = null

Methods

_getHostnameFromFriendlyName

_getHostnameFromFriendlyName(): string

- Defined in RICSystem.ts:575
Get hostname of connected WiFi

Returns string
string - hostname of connected WiFi

calibrate

calibrate(cmd: string, jointList: string[], jointNames: {}, servoControllers?: {}): Promise<false | RICOKFail>

- Defined in RICSystem.ts:179
Parameters
- cmd: string
- jointList: string[]
- jointNames: {}
  - [key: string]: string
- servoControllers: {} = ...
  - [key: string]: string
Returns Promise<false | RICOKFail>

getAddOnConfigs

getAddOnConfigs(): Promise<RICConfiguredAddOns>

- Defined in RICSystem.ts:478
getAddOnConfigs - get list of add-ons configured on the robot

Returns Promise<RICConfiguredAddOns>
Promise

getCachedAddOnList

getCachedAddOnList(): RICHWElem[]

- Defined in RICSystem.ts:761
Returns RICHWElem[]

getCachedAllHWElems

getCachedAllHWElems(): RICHWElem[]

- Defined in RICSystem.ts:765
Returns RICHWElem[]

getCachedCalibInfo

getCachedCalibInfo(): null | RICCalibInfo

- Defined in RICSystem.ts:772
Returns null | RICCalibInfo

getCachedRICName

getCachedRICName(): null | RICFriendlyName

- Defined in RICSystem.ts:776
Returns null | RICFriendlyName

getCachedSystemInfo

getCachedSystemInfo(): null | RICSystemInfo

- Defined in RICSystem.ts:757
Returns null | RICSystemInfo

getCachedWifiStatus

getCachedWifiStatus(): RICWifiConnStatus

- Defined in RICSystem.ts:780
Returns RICWifiConnStatus

getFileList

getFileList(): Promise<RICFileList>

- Defined in RICSystem.ts:497
getFileList - get list of files on file system

Returns Promise<RICFileList>
Promise

getFriendlyName

getFriendlyName(): null | RICFriendlyName

- Defined in RICSystem.ts:75
getFriendlyName

Returns null | RICFriendlyName
friendly name

getHWElemList

getHWElemList(filterByType?: string): Promise<RICHWElem[]>

- Defined in RICSystem.ts:358
getHWElemList - get the list of hardware elements connected to the robot - the result (if successful) is processed as follows: = if no filter is applied then all non-add-ons found are stored in this._hwElemsExcludingAddOns and all addons are stored in this._connectedAddOns = if a filter is applied and this filter is RSAddOns then this._connectedAddOns is updated with the new list of addons = in all cases the discovered list is returned

Parameters
- Optional filterByType: string
Returns Promise<RICHWElem[]>
Promise

getRICCalibInfo

getRICCalibInfo(forceGetFromRIC?: boolean): Promise<RICCalibInfo>

- Defined in RICSystem.ts:260
getRICCalibInfo

Parameters
- forceGetFromRIC: boolean = false
Returns Promise<RICCalibInfo>
Promise

getRICName

getRICName(): Promise<RICFriendlyName>

- Defined in RICSystem.ts:317
getRICName

Returns Promise<RICFriendlyName>
Promise (object containing rslt)

getRICSystemInfo

getRICSystemInfo(forceGetFromRIC?: boolean): Promise<RICSystemInfo>

- Defined in RICSystem.ts:159
getRICSystemInfo

Parameters
- forceGetFromRIC: boolean = false
Returns Promise<RICSystemInfo>
Promise

getSysModInfoBLEMan

getSysModInfoBLEMan(): Promise<null | RICSysModInfoBLEMan>

- Defined in RICSystem.ts:543
Get BLEMan sysmod info

Returns Promise<null | RICSysModInfoBLEMan>
RICSysModInfoBLEMan

getWiFiConnStatus

getWiFiConnStatus(): Promise<null | boolean>

- Defined in RICSystem.ts:592
Get Wifi connection status

Returns Promise<null | boolean>
boolean - true if connected

invalidate

invalidate(): void

- Defined in RICSystem.ts:82
invalidate

Returns void

pauseWifiConnection

pauseWifiConnection(pause: boolean): Promise<boolean>

- Defined in RICSystem.ts:637
pause Wifi connection

Parameters
- pause: boolean
Returns Promise<boolean>
boolean - true if successful

retrieveInfo

retrieveInfo(): Promise<boolean>

- Defined in RICSystem.ts:98
getSystemInfo - get system info

Returns Promise<boolean>
Promise

runCommand

runCommand(commandName: string, params: object): Promise<RICOKFail>

- Defined in RICSystem.ts:518
runCommand

Parameters
- commandName: string
  
  command API string
- params: object
  
  parameters (simple name value pairs only) to parameterize trajectory
Returns Promise<RICOKFail>
Promise

setRICName

setRICName(newName: string): Promise<boolean>

- Defined in RICSystem.ts:284
setRICName

Parameters
- newName: string
  
  name to refer to RIC - used for BLE advertising
Returns Promise<boolean>
Promise true if successful

wifiConnect

wifiConnect(ssid: string, password: string): Promise<boolean>

- Defined in RICSystem.ts:659
Connect to WiFi

Parameters
- ssid: string
- password: string
Returns Promise<boolean>
boolean - true if successful

wifiDisconnect

wifiDisconnect(): Promise<boolean>

- Defined in RICSystem.ts:708
Disconnect WiFi

Returns Promise<boolean>
boolean - true if successful

wifiScanResults

wifiScanResults(): Promise<boolean | RICOKFail | RICWifiScanResults>

- Defined in RICSystem.ts:745
WiFiScan get results

Returns Promise<boolean | RICOKFail | RICWifiScanResults>
boolean - false if unsuccessful, otherwise the results of the promise

wifiScanStart

wifiScanStart(): Promise<boolean>

- Defined in RICSystem.ts:729
WiFiScan start

Returns Promise<boolean>
boolean - true if successful

Generated using TypeDoc