Class RobotService

Hierarchy

BaseService
- RobotService

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new RobotService(options: IRocosClientOptions): RobotService

Inherited from BaseService.constructor
- Defined in src/services/base-service.ts:9
Parameters
- options: IRocosClientOptions
Returns RobotService

Properties

Protected httpRequest

httpRequest: HttpRequest

Protected options

options: IRocosClientOptions

Methods

AddEventDefinitions

AddEventDefinitions(projectId: string, callsign: string, model: any): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:647
Parameters
- projectId: string
- callsign: string
- model: any
Returns Observable<RocosResponse<any>>

attributes

attributes(projectId: string, callsign: string): Observable<RocosResponse<Record<string, string>>>

- Defined in src/services/robot-service.ts:123
Get robot attributes by project id and callsign of the robot.

Parameters
- projectId: string
  
  Project Id
- callsign: string
  
  Callsign of the robot
Returns Observable<RocosResponse<Record<string, string>>>

create

create(projId: string, robot: Robot): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:29
Create a new robot.

Parameters
- projId: string
  
  Project Id
- robot: Robot
  
  Robot object
Returns Observable<RocosResponse<any>>

createDashboardsV2

createDashboardsV2(projectId: string, profileId: string, model: any): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:427
Parameters
- projectId: string
- profileId: string
- model: any
Returns Observable<RocosResponse<any>>

createRobotDashboardsV2

createRobotDashboardsV2(projectId: string, callsign: string, model: any): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:416
Parameters
- projectId: string
- callsign: string
- model: any
Returns Observable<RocosResponse<any>>

dataSourcesSchema

dataSourcesSchema(): Observable<RocosResponse<RobotTemplate[]>>

- Defined in src/services/robot-service.ts:210
Get data sources tree components JSON schema

Returns Observable<RocosResponse<RobotTemplate[]>>

delete

delete(projectId: string, callsignIds: string[]): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:89
Delete the robots by callsign list

Parameters
- projectId: string
  
  Project Id
- callsignIds: string[]
  
  Callsign list
Returns Observable<RocosResponse<any>>

deleteDashboardsV2

deleteDashboardsV2(projectId: string, profileId: string, id: string): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:339
Parameters
- projectId: string
- profileId: string
- id: string
Returns Observable<RocosResponse<any>>

deleteRobotDashboardsV2

deleteRobotDashboardsV2(projectId: string, callsign: string, id: string): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:329
Parameters
- projectId: string
- callsign: string
- id: string
Returns Observable<RocosResponse<any>>

deployVirtualRobot

deployVirtualRobot(projectId: string, callsign: string): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:194
Deploy a virtual robot by project id and callsign

Parameters
- projectId: string
  
  Project Id
- callsign: string
  
  Robot's Callsign
Returns Observable<RocosResponse<any>>

getAgentSettings

getAgentSettings(projectId: string, callsign: string): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:562
Parameters
- projectId: string
- callsign: string
Returns Observable<RocosResponse<any>>

getButtons

getButtons(projectId: string, callsign: string): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:752
Parameters
- projectId: string
- callsign: string
Returns Observable<RocosResponse<any>>

getCommands

getCommands(projectId: string, callsign: string): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:604
Parameters
- projectId: string
- callsign: string
Returns Observable<RocosResponse<any>>

getCommandsV2

getCommandsV2(projectId: string, callsign: string): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:699
Parameters
- projectId: string
- callsign: string
Returns Observable<RocosResponse<any>>

getDashboardBlobV2

getDashboardBlobV2(projectId: string, callsign: string, id: string): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:476
Get robot dashboard which stored in Azure Blob.

Parameters
- projectId: string
  
  Project ID
- callsign: string
  
  Robot Callsign
- id: string
Returns Observable<RocosResponse<any>>

getDashboardsV2

getDashboardsV2(projectId: string, callsign: string, id: string): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:461
Parameters
- projectId: string
- callsign: string
- id: string
Returns Observable<RocosResponse<any>>

getEventDefinitions

getEventDefinitions(projectId: string, callsign: string, includeCounts?: number): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:626
Parameters
- projectId: string
- callsign: string
- Default value includeCounts: number = 0
Returns Observable<RocosResponse<any>>

getEventHistory

getEventHistory(projectId: string, callsign: string, eventDefinitionId: string): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:637
Parameters
- projectId: string
- callsign: string
- eventDefinitionId: string
Returns Observable<RocosResponse<any>>

getGamepads

getGamepads(projectId: string, callsign: string): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:836
Parameters
- projectId: string
- callsign: string
Returns Observable<RocosResponse<any>>

getSettings

getSettings(projectId: string, callsign: string): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:520
Parameters
- projectId: string
- callsign: string
Returns Observable<RocosResponse<any>>

getTriggers

getTriggers(projectId: string, callsign: string): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:794
Parameters
- projectId: string
- callsign: string
Returns Observable<RocosResponse<any>>

info

info(projectId: string, callsign: string): Observable<RocosResponse<Robot>>

- Defined in src/services/robot-service.ts:105
Get robot information by project id and callsign of the robot.

Parameters
- projectId: string
  
  Project Id
- callsign: string
  
  Callsign of the robot
Returns Observable<RocosResponse<Robot>>

list

list(projId: string): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:51
Get robots list by project id.

Parameters
- projId: string
Returns Observable<RocosResponse<any>>

listDashboardsV2

listDashboardsV2(projectId: string, profileId: string): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:358
Parameters
- projectId: string
- profileId: string
Returns Observable<RocosResponse<any>>

listRobotDashboardsV2

listRobotDashboardsV2(projectId: string, callsign: string): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:349
Parameters
- projectId: string
- callsign: string
Returns Observable<RocosResponse<any>>

register

register(projectId: string, callsign: string): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:140
Register the specified callsign

Parameters
- projectId: string
  
  Project Id
- callsign: string
  
  Callsign of the robot
Returns Observable<RocosResponse<any>>

robotDefAddEventDefinitions

robotDefAddEventDefinitions(projectId: string, defId: string, model: any): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:666
Parameters
- projectId: string
- defId: string
- model: any
Returns Observable<RocosResponse<any>>

robotDefCopyDef

robotDefCopyDef(projectId: string, defId: string, model: any): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:299
Parameters
- projectId: string
- defId: string
- model: any
Returns Observable<RocosResponse<any>>

robotDefDashboardBlob

robotDefDashboardBlob(projectId: string, defId: string): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:407
Get Dashboard data which stored in Azure Blob.

Parameters
- projectId: string
  
  Project ID
- defId: string
  
  Robot Profile ID
Returns Observable<RocosResponse<any>>

robotDefDashboardBlobV2

robotDefDashboardBlobV2(projectId: string, profileId: string, dashboardId: string): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:391
Get Dashboard data which stored in Azure Blob.

Parameters
- projectId: string
  
  Project ID
- profileId: string
  
  Robot Profile ID
- dashboardId: string
Returns Observable<RocosResponse<any>>

robotDefDashboards

robotDefDashboards(projectId: string, defId: string): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:376
Parameters
- projectId: string
- defId: string
Returns Observable<RocosResponse<any>>

robotDefDashboardsV2

robotDefDashboardsV2(projectId: string, profileId: string, id: string): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:367
Parameters
- projectId: string
- profileId: string
- id: string
Returns Observable<RocosResponse<any>>

robotDefGetAgentSettings

robotDefGetAgentSettings(projectId: string, defId: string): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:542
Parameters
- projectId: string
- defId: string
Returns Observable<RocosResponse<any>>

robotDefGetButtons

robotDefGetButtons(projectId: string, defId: string): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:732
Parameters
- projectId: string
- defId: string
Returns Observable<RocosResponse<any>>

robotDefGetCommandActions

robotDefGetCommandActions(projectId: string, defId: string): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:721
Parameters
- projectId: string
- defId: string
Returns Observable<RocosResponse<any>>

robotDefGetCommands

robotDefGetCommands(projectId: string, defId: string): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:584
Parameters
- projectId: string
- defId: string
Returns Observable<RocosResponse<any>>

robotDefGetCommandsV2

robotDefGetCommandsV2(projectId: string, defId: string): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:679
Parameters
- projectId: string
- defId: string
Returns Observable<RocosResponse<any>>

robotDefGetEventDefinitions

robotDefGetEventDefinitions(projectId: string, defId: string): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:657
Parameters
- projectId: string
- defId: string
Returns Observable<RocosResponse<any>>

robotDefGetGamepads

robotDefGetGamepads(projectId: string, defId: string): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:816
Parameters
- projectId: string
- defId: string
Returns Observable<RocosResponse<any>>

robotDefGetSettings

robotDefGetSettings(projectId: string, defId: string): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:500
Parameters
- projectId: string
- defId: string
Returns Observable<RocosResponse<any>>

robotDefGetTriggers

robotDefGetTriggers(projectId: string, defId: string): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:774
Parameters
- projectId: string
- defId: string
Returns Observable<RocosResponse<any>>

robotDefUpdateAgentSettings

robotDefUpdateAgentSettings(projectId: string, defId: string, model: any): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:551
Parameters
- projectId: string
- defId: string
- model: any
Returns Observable<RocosResponse<any>>

robotDefUpdateButtons

robotDefUpdateButtons(projectId: string, defId: string, model: any): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:741
Parameters
- projectId: string
- defId: string
- model: any
Returns Observable<RocosResponse<any>>

robotDefUpdateCommands

robotDefUpdateCommands(projectId: string, defId: string, model: any): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:593
Parameters
- projectId: string
- defId: string
- model: any
Returns Observable<RocosResponse<any>>

robotDefUpdateCommandsV2

robotDefUpdateCommandsV2(projectId: string, defId: string, model: any): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:688
Parameters
- projectId: string
- defId: string
- model: any
Returns Observable<RocosResponse<any>>

robotDefUpdateDashboards

robotDefUpdateDashboards(projectId: string, defId: string, model: any): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:450
Parameters
- projectId: string
- defId: string
- model: any
Returns Observable<RocosResponse<any>>

robotDefUpdateDashboardsV2

robotDefUpdateDashboardsV2(projectId: string, defId: string, id: string, model: any): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:438
Parameters
- projectId: string
- defId: string
- id: string
- model: any
Returns Observable<RocosResponse<any>>

robotDefUpdateGamepads

robotDefUpdateGamepads(projectId: string, defId: string, model: any): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:825
Parameters
- projectId: string
- defId: string
- model: any
Returns Observable<RocosResponse<any>>

robotDefUpdateSettings

robotDefUpdateSettings(projectId: string, defId: string, model: any): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:509
Parameters
- projectId: string
- defId: string
- model: any
Returns Observable<RocosResponse<any>>

robotDefUpdateTriggers

robotDefUpdateTriggers(projectId: string, defId: string, model: any): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:783
Parameters
- projectId: string
- defId: string
- model: any
Returns Observable<RocosResponse<any>>

robotDefsCreate

robotDefsCreate(projectId: string, model: any): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:222
Parameters
- projectId: string
- model: any
Returns Observable<RocosResponse<any>>

robotDefsDeleteOne

robotDefsDeleteOne(projectId: string, defId: string): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:259
Parameters
- projectId: string
- defId: string
Returns Observable<RocosResponse<any>>

robotDefsForRobot

robotDefsForRobot(projectId: string, callsign: string): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:279
Parameters
- projectId: string
- callsign: string
Returns Observable<RocosResponse<any>>

robotDefsGetOne

robotDefsGetOne(projectId: string, defId: string): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:250
Parameters
- projectId: string
- defId: string
Returns Observable<RocosResponse<any>>

robotDefsList

robotDefsList(projectId: string): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:232
Parameters
- projectId: string
Returns Observable<RocosResponse<any>>

robotDefsRemove

robotDefsRemove(projectId: string, defIds: string[]): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:240
Parameters
- projectId: string
- defIds: string[]
Returns Observable<RocosResponse<any>>

robotDefsUpdateOne

robotDefsUpdateOne(projectId: string, defId: string, model: any): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:268
Parameters
- projectId: string
- defId: string
- model: any
Returns Observable<RocosResponse<any>>

robotDefsUpdateStorageStreams

robotDefsUpdateStorageStreams(projectId: string, defId: string, model: any): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:288
Parameters
- projectId: string
- defId: string
- model: any
Returns Observable<RocosResponse<any>>

robotListForDefs

robotListForDefs(projectId: string, defId: string): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:310
Parameters
- projectId: string
- defId: string
Returns Observable<RocosResponse<any>>

templates

templates(): Observable<RocosResponse<RobotTemplate[]>>

- Defined in src/services/robot-service.ts:157
Robot Templates

Returns Observable<RocosResponse<RobotTemplate[]>>

update

update(projectId: string, robot: Robot): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:65
Update robot information.

Parameters
- projectId: string
  
  Project Id
- robot: Robot
Returns Observable<RocosResponse<any>>

updateAgentSettings

updateAgentSettings(projectId: string, callsign: string, model: any): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:571
Parameters
- projectId: string
- callsign: string
- model: any
Returns Observable<RocosResponse<any>>

updateButtons

updateButtons(projectId: string, callsign: string, model: any): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:761
Parameters
- projectId: string
- callsign: string
- model: any
Returns Observable<RocosResponse<any>>

updateCommands

updateCommands(projectId: string, callsign: string, model: any): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:613
Parameters
- projectId: string
- callsign: string
- model: any
Returns Observable<RocosResponse<any>>

updateCommandsV2

updateCommandsV2(projectId: string, callsign: string, model: any): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:708
Parameters
- projectId: string
- callsign: string
- model: any
Returns Observable<RocosResponse<any>>

updateDashboardsV2

updateDashboardsV2(projectId: string, callsign: string, id: string, model: any): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:486
Parameters
- projectId: string
- callsign: string
- id: string
- model: any
Returns Observable<RocosResponse<any>>

updateGamepads

updateGamepads(projectId: string, callsign: string, model: any): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:845
Parameters
- projectId: string
- callsign: string
- model: any
Returns Observable<RocosResponse<any>>

updateSettings

updateSettings(projectId: string, callsign: string, model: any): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:529
Parameters
- projectId: string
- callsign: string
- model: any
Returns Observable<RocosResponse<any>>

updateTriggers

updateTriggers(projectId: string, callsign: string, model: any): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:803
Parameters
- projectId: string
- callsign: string
- model: any
Returns Observable<RocosResponse<any>>

virtualRobotDeploymentDetails

virtualRobotDeploymentDetails(projectId: string, callsign: string): Observable<RocosResponse<any>>

- Defined in src/services/robot-service.ts:177
Get the deployment details of virtual robot.

Parameters
- projectId: string
  
  Project ID
- callsign: string
  
  Virtual Robot Callsign
Returns Observable<RocosResponse<any>>

Generated using TypeDoc