IRobotParameterManager | Dart-API Doc V3

IRobotParameterManager have APIs for robot parameters setting.

api-version: 1
system

Hierarchy

ISystemManager
- IRobotParameterManager

Properties

cockpit

cockpit: IParameterItem<CockPit>

Cockpit setting api

api-version: 1
user

collisionSensitivity

collisionSensitivity: IParameterItem<number>

Collision sensitivity setting api

api-version: 1
user

generalRange

generalRange: IParameterItem<GeneralRange>

General Range setting api

api-version: 1
user

homingOption

homingOption: IParameterItem<HomingOption>

Homing option setting api

api-version: 1
user

idleServoOff

idleServoOff: IParameterItem<IdleServoOff>

Idle servo off setting api

api-version: 1
user

installPose

installPose: IParameterItem<InstallPose>

Install pose setting api

api-version: 1
user

ioSpeedRatio

ioSpeedRatio: IParameterItem<number>

IO speed ratio setting api

api-version: 1
user

jointRange

jointRange: IParameterItem<JointRange>

Joint range setting api

api-version: 1
user

normalIo

normalIo: IParameterItem<NormalIO>

Normal IO setting api

api-version: 1
user

nudge

nudge: IParameterItem<Nudge>

Nudge setting api

api-version: 1
user

recentFile

recentFile: Monitorable<{ data: RobotParameter; name: string }>

Monitorable RobotParameter. Recent robot parameter file information.

api-version: 1
user

safetyIo

safetyIo: IParameterItem<SafetyIO>

Safety IO setting api

api-version: 1
user

safetyStopMode

safetyStopMode: IParameterItem<SafetyStopMode>

Safety stop mode setting api

api-version: 1
user

safetyZone

safetyZone: IParameterMultiItem<SafetyZone>

Safety Zone setting api

api-version: 1
user

tcp

tcp: IParameterSelectableItem<ToolCenterPoint>

Tool center point setting api

api-version: 1
user

toolShape

toolShape: IParameterSelectableItem<ToolShape>

Tool shape setting api

api-version: 1
user

toolWeight

toolWeight: IParameterSelectableItem<ToolWeight>

Tool weight setting api

api-version: 1
user

userCoordinate

userCoordinate: IParameterMultiItem<UserCoordinate>

User Coordinate setting api

api-version: 1
user

worldToBaseRelation

worldToBaseRelation: IParameterItem<World2BaseRelation>

World to base relation pose setting api

api-version: 1
user

Methods

add

add(name: string, data: RobotParameter): Promise<boolean>
add(name: string, data: RobotParameter, options?: { withoutRecentFile?: boolean }): Promise<boolean>

- Defined in src/api/dart-api.ts:17642
Add robot parameter to db

api-version
1

system
Parameters
- name: string
  
  robot parameter name
- data: RobotParameter
  
  RobotParameter
Returns Promise<boolean>
Return Fulfills with true if the request has been operated successfully, otherwise false.
- Defined in src/api/dart-api.ts:17655
Add robot parameter to db

api-version
3

system
Parameters
- name: string
  
  robot parameter name
- data: RobotParameter
  
  RobotParameter
- Optional options: { withoutRecentFile?: boolean }
  
  Additional options.
  - Optional withoutRecentFile?: boolean
Returns Promise<boolean>
Return Fulfills with true if the request has been operated successfully, otherwise false.

addSystemVariable

addSystemVariable(data: SystemVariable): Promise<boolean>

- Defined in src/api/dart-api.ts:17858
Add system variable

api-version
1

system
Parameters
- data: SystemVariable
  
  SystemVariable
Returns Promise<boolean>
Return Fulfills with true if the request has been operated successfully, otherwise false.

delSystemVariable

delSystemVariable(name: string): Promise<boolean>

- Defined in src/api/dart-api.ts:17880
Delete system variable

api-version
1

system
Parameters
- name: string
  
  name of system variable
Returns Promise<boolean>
Return Fulfills with true if the request has been operated successfully, otherwise false.

get

get(name: string): Promise<null | RobotParameter>

- Defined in src/api/dart-api.ts:17678
Get robot parameter in db

api-version
1

user
Parameters
- name: string
  
  robot parameter name
Returns Promise<null | RobotParameter>
Return Robot Parameter RobotParameter

getAll

getAll(): Promise<{ data: RobotParameter; name: string }[]>

- Defined in src/api/dart-api.ts:17688
Get robot parameter in db

api-version
1

user
Returns Promise<{ data: RobotParameter; name: string }[]>
Return robot parameter array RobotParameter

getAllName

getAllName(): Promise<string[]>

- Defined in src/api/dart-api.ts:17630
Get all robot parameter names added.

api-version
1

user
Returns Promise<string[]>
Promise<string[]> return all robot parameter names added.

getControllerAnalogIoAlias

getControllerAnalogIoAlias(): Promise<null | ControllerAnalogIoAlias>

- Defined in src/api/dart-api.ts:17805
Get Controller Analog I/O Alias

api-version
1

user
Returns Promise<null | ControllerAnalogIoAlias>
Return Controller Analog I/O Alias ControllerAnalogIoAlias

getControllerDigitalIoAlias

getControllerDigitalIoAlias(): Promise<null | ControllerDigitalIoAlias>

- Defined in src/api/dart-api.ts:17763
Get Controller Digital I/O Alias

api-version
1

user
Returns Promise<null | ControllerDigitalIoAlias>
Return Controller Digital I/O Alias ControllerDigitalIoAlias

getFlangeAnalogIoAlias

getFlangeAnalogIoAlias(): Promise<null | FlangeAnalogIoAlias>

- Defined in src/api/dart-api.ts:17826
Get Flange Analog I/O Alias

api-version
1

user
Returns Promise<null | FlangeAnalogIoAlias>
Return Flange Analog I/O Alias FlangeAnalogIoAlias

getFlangeDigitalIoAlias

getFlangeDigitalIoAlias(): Promise<null | FlangeDigitalIoAlias>

- Defined in src/api/dart-api.ts:17784
Get Flange Digital I/O Alias

api-version
1

user
Returns Promise<null | FlangeDigitalIoAlias>
Return Flange Digital I/O Alias FlangeDigitalIoAlias

getHomingOption

getHomingOption(): Promise<HomingOption>

- Defined in src/api/dart-api.ts:17913
get option of move home

api-version
1

user
Returns Promise<HomingOption>
move home option.

getInitialValue

getInitialValue(robotModel: RobotModel): RobotParameter

- Defined in src/api/dart-api.ts:17710
Get Initial Robot Parameter

api-version
1

user
Parameters
- robotModel: RobotModel
  
  robot model RobotModel
Returns RobotParameter
Return Initial Robot Parameter RobotParameter

getMaxPayload

getMaxPayload(robotModel: RobotModel): number

- Defined in src/api/dart-api.ts:17732
Get Max Payload

api-version
1

user
Parameters
- robotModel: RobotModel
  
  robot model RobotModel
Returns number
Return Max Payload [kg]

getRobotLimit

getRobotLimit(robotModel: RobotModel): RobotLimit

- Defined in src/api/dart-api.ts:17721
Get Robot Limit Value

api-version
1

user
Parameters
- robotModel: RobotModel
  
  robot model RobotModel
Returns RobotLimit
Return Robot Limits RobotLimit

getSystem

getSystem(): RobotParameter

- Defined in src/api/dart-api.ts:17742
Get Robot Parameters in Controller System

api-version
1

user
Returns RobotParameter
Return Robot Parameter RobotParameter

getSystemVariables

getSystemVariables(): Promise<SystemVariable[]>

- Defined in src/api/dart-api.ts:17847
Get system variable list

api-version
1

user
Returns Promise<SystemVariable[]>
System Variable list SystemVariable

manageTools

manageTools(settings: { add?: { tcp?: ToolCenterPoint[]; toolShape?: ToolShape[]; toolWeight?: ToolWeight[] }; del?: { tcp?: string[]; toolShape?: string[]; toolWeight?: string[] }; set?: { tcp?: ToolCenterPoint[]; toolShape?: ToolShape[]; toolWeight?: ToolWeight[] } }): Promise<ToolManageResult | { tcp: { name: string; result: ToolManageResult }[]; toolShape: { name: string; result: ToolManageResult }[]; toolWeight: { name: string; result: ToolManageResult }[] }>

- Defined in src/api/dart-api.ts:17924
Request to manage tool settings.

api-version
3

user
Parameters
- settings: { add?: { tcp?: ToolCenterPoint[]; toolShape?: ToolShape[]; toolWeight?: ToolWeight[] }; del?: { tcp?: string[]; toolShape?: string[]; toolWeight?: string[] }; set?: { tcp?: ToolCenterPoint[]; toolShape?: ToolShape[]; toolWeight?: ToolWeight[] } }
  - Optional add?: { tcp?: ToolCenterPoint[]; toolShape?: ToolShape[]; toolWeight?: ToolWeight[] }
    - Optional tcp?: ToolCenterPoint[]
    - Optional toolShape?: ToolShape[]
    - Optional toolWeight?: ToolWeight[]
  - Optional del?: { tcp?: string[]; toolShape?: string[]; toolWeight?: string[] }
    - Optional tcp?: string[]
    - Optional toolShape?: string[]
    - Optional toolWeight?: string[]
  - Optional set?: { tcp?: ToolCenterPoint[]; toolShape?: ToolShape[]; toolWeight?: ToolWeight[] }
    - Optional tcp?: ToolCenterPoint[]
    - Optional toolShape?: ToolShape[]
    - Optional toolWeight?: ToolWeight[]
Returns Promise<ToolManageResult | { tcp: { name: string; result: ToolManageResult }[]; toolShape: { name: string; result: ToolManageResult }[]; toolWeight: { name: string; result: ToolManageResult }[] }>
Return Fulfills with array of name and ToolManageResult pairs if the request has been operated successfully, otherwise ToolManageResult.

remove

remove(name: string): Promise<boolean>

- Defined in src/api/dart-api.ts:17699
remove robot parameter in db

api-version
1

system
Parameters
- name: string
  
  robot parameter name
Returns Promise<boolean>
Return Fulfills with true if the request has been operated successfully, otherwise false.

set

set(name: string, data: RobotParameter): Promise<boolean>

- Defined in src/api/dart-api.ts:17667
Set robot parameter in db

api-version
1

system
Parameters
- name: string
  
  robot parameter name
- data: RobotParameter
  
  RobotParameter
Returns Promise<boolean>
Return Fulfills with true if the request has been operated successfully, otherwise false.

setControllerAnalogIoAlias

setControllerAnalogIoAlias(data: ControllerAnalogIoAlias): Promise<boolean>

- Defined in src/api/dart-api.ts:17816
Set Controller Analog I/O Alias

api-version
1

system
Parameters
- data: ControllerAnalogIoAlias
  
  ControllerAnalogIoAlias
Returns Promise<boolean>
Return Fulfills with true if the request has been operated successfully, otherwise false.

setControllerDigitalIoAlias

setControllerDigitalIoAlias(data: ControllerDigitalIoAlias): Promise<boolean>

- Defined in src/api/dart-api.ts:17774
Set Controller Digital I/O Alias

api-version
1

system
Parameters
- data: ControllerDigitalIoAlias
  
  ControllerDigitalIoAlias
Returns Promise<boolean>
Return Fulfills with true if the request has been operated successfully, otherwise false.

setFlangeAnalogIoAlias

setFlangeAnalogIoAlias(data: FlangeAnalogIoAlias): Promise<boolean>

- Defined in src/api/dart-api.ts:17837
Set Flange Analog I/O Alias

api-version
1

system
Parameters
- data: FlangeAnalogIoAlias
  
  FlangeAnalogIoAlias
Returns Promise<boolean>
Return Fulfills with true if the request has been operated successfully, otherwise false.

setFlangeDigitalIoAlias

setFlangeDigitalIoAlias(data: FlangeDigitalIoAlias): Promise<boolean>

- Defined in src/api/dart-api.ts:17795
Set Flange Digital I/O Alias

api-version
1

system
Parameters
- data: FlangeDigitalIoAlias
  
  FlangeDigitalIoAlias
Returns Promise<boolean>
Return Fulfills with true if the request has been operated successfully, otherwise false.

setHomingOption

setHomingOption(data: HomingOption): Promise<boolean>

- Defined in src/api/dart-api.ts:17892
set option of move home

api-version
1

system
Parameters
- data: HomingOption
Returns Promise<boolean>
Promise

setSystem

setSystem(data: RobotParameter): Promise<boolean>

- Defined in src/api/dart-api.ts:17753
Set Robot Parameters in Controller System

api-version
1

system
Parameters
- data: RobotParameter
  
  RobotParameter
Returns Promise<boolean>
Return Fulfills with true if the request has been operated successfully, otherwise false.

setSystemVariable

setSystemVariable(data: SystemVariable): Promise<boolean>

- Defined in src/api/dart-api.ts:17869
Set system variable

api-version
1

system
Parameters
- data: SystemVariable
  
  SystemVariable
Returns Promise<boolean>
Return Fulfills with true if the request has been operated successfully, otherwise false.

setUseUserHome

setUseUserHome(use: boolean): Promise<boolean>

- Defined in src/api/dart-api.ts:17903
set wheter to use custom home position.

api-version
2

system
Parameters
- use: boolean
  
  use moveToUserHome(true), use moveToHWHome(false)
Returns Promise<boolean>
Promise

Hierarchy

Index

Properties

Methods

Properties

cockpit

collisionSensitivity

generalRange

homingOption

idleServoOff

installPose

ioSpeedRatio

jointRange

normalIo

nudge

recentFile

safetyIo

safetyStopMode

safetyZone

tcp

toolShape

toolWeight

userCoordinate

worldToBaseRelation

Methods

add

Parameters

name: string

data: RobotParameter

Returns Promise<boolean>

Parameters

name: string

data: RobotParameter

Optional options: { withoutRecentFile?: boolean }

Optional withoutRecentFile?: boolean

Returns Promise<boolean>

addSystemVariable

Parameters

data: SystemVariable

Returns Promise<boolean>

delSystemVariable

Parameters

name: string

Returns Promise<boolean>

get

Parameters

name: string

Returns Promise<null | RobotParameter>

getAll

Returns Promise<{ data: RobotParameter; name: string }[]>

getAllName

Returns Promise<string[]>

getControllerAnalogIoAlias

Returns Promise<null | ControllerAnalogIoAlias>

getControllerDigitalIoAlias

Returns Promise<null | ControllerDigitalIoAlias>

getFlangeAnalogIoAlias

Returns Promise<null | FlangeAnalogIoAlias>

getFlangeDigitalIoAlias

Returns Promise<null | FlangeDigitalIoAlias>

getHomingOption

Returns Promise<HomingOption>

getInitialValue

Parameters

robotModel: RobotModel

Returns RobotParameter

getMaxPayload

Parameters

robotModel: RobotModel

Returns number

getRobotLimit

Parameters

robotModel: RobotModel

Returns RobotLimit

getSystem

Returns RobotParameter

getSystemVariables

Returns Promise<SystemVariable[]>

manageTools

Parameters