Preparing search index...
The search index is not available
motion-master-client
motion-master-client
ensureDeviceRef
Function ensureDeviceRef
ensure
Device
Ref
(
deviceRef
:
DeviceRef
)
:
DeviceRef
Parameters
deviceRef:
DeviceRef
Returns
DeviceRef
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
Modules
motion-
master-
client
Motion
Master
Message
Request
Compute
Auto
Tuning
Gains
Position
Parameters
Compute
Full
Auto
Tuning
Gains
Enable
Motion
Controller
Get
Device
Parameter
Values
Set
Device
Ci
A402
State
Set
Device
Parameter
Values
Set
Ethercat
Network
State
Set
Signal
Generator
Parameters
Start
Full
Auto
Tuning
Status
Auto
Tuning
Error
Success
Warning
Circulo
Encoder
Configuration
Error
Success
Circulo
Encoder
Narrow
Angle
Calibration
Procedure
Error
Success
Warning
Cogging
Torque
Data
Error
Cogging
Torque
Recording
Error
Success
Device
Ci
A402
State
Error
Success
Device
Event
Device
Fault
Reset
Error
Success
Warning
Device
File
Error
Success
Device
File
List
Error
Device
Firmware
Installation
Error
Success
Warning
Device
Info
Device
Device
Log
Error
Device
Parameter
Info
Parameter
Device
Parameter
Values
Parameter
Value
Error
Success
Device
Sii
Restore
Error
Success
Device
Stop
Error
Success
Ethercat
Network
State
Error
Success
Full
Auto
Tuning
Error
Success
Warning
Monitoring
Parameter
Values
Error
Success
Warning
Motion
Controller
Error
Success
Narrow
Angle
Calibration
Error
Success
Offset
Detection
Error
Progress
Success
Open
Loop
Field
Control
Error
Success
Os
Command
Error
Success
Plant
Identification
Error
Success
Signal
Generator
Error
Success
Warning
System
Event
Error
Info
Success
Warning
System
Identification
Error
Success
Warning
Controller
Type
Ethercat
Network
State
Value
Type
Cia402
State
Controlword
Command
Encoder
Register
Address
Ethercat
State
Hrd
Streaming
Os
Command
Action
Hrd
Streaming
Os
Command
Data
Index
Kubler
Encoder
Subcommand
Id
Modes
Of
Operation
Object
Code
Definition
Os
Command
Id
Os
Command
Mode
Restore
Default
Parameters
Type
Sii
Category
Type
Smm
Acyclic
Handler
Subcommand
Id
Config
File
Data
Monitoring
Ethernet
Device
Integro
Encoder
Calibration
Motion
Composer
Runner
Motion
Master
Client
Motion
Master
Message
Motion
Master
Pub
Sub
Client
Motion
Master
Pub
Sub
Web
Socket
Motion
Master
Pub
Sub
Worker
Socket
Motion
Master
Req
Res
Client
Motion
Master
Req
Res
Web
Socket
Motion
Master
Req
Res
Worker
Socket
Request
Error
Assembly
Base
Data
Type
Board
Circulo
Encoder
Battery
Mode
Commutation
Offset
Measurement
Os
Command
Response
Device
Device
Log
Line
Device
Parameter
Device
Parameter
Info
Encoder
Register
Communication
Os
Command
Response
Encoder
Register
Error
Ethernet
Device
Parameter
Ethernet
Pdo
Entry
Firmware
Firmware
Id
Hardware
Component
Hardware
Description
Hardware
Device
Homing
Procedure
Config
Homing
Procedure
Status
Hrd
Streaming
Os
Command
Response
IMotion
Master
Message
Ic
Mu
Calibration
Mode
Os
Command
Response
Ignore
Biss
Status
Bits
Os
Command
Response
Integro
Variant
Integro
Variant
Header
Integro
Variant
Option
Integro
Variant
Selected
Option
Id
Kubler
Encoder
Command
Os
Command
Response
Kubler
Encoder
Register
Communication
Os
Command
Response
Monitoring
Config
Monitoring
Entry
Motion
Composer
Motion
Composer
Flow
Motion
Composer
Flow
Command
Motion
Composer
Flow
Command
Delay
Motion
Composer
Flow
Command
Download
Motion
Composer
Flow
Command
Quick
Stop
Motion
Composer
Flow
Command
Reset
Fault
Motion
Composer
Flow
Command
Run
Position
Profile
Motion
Composer
Flow
Command
Run
Torque
Profile
Motion
Composer
Flow
Command
Run
Velocity
Profile
Motion
Composer
Flow
Command
Set
Modes
Of
Operation
Motion
Composer
Flow
Command
Transition
To
Cia402
State
Motion
Composer
Flow
Command
Upload
Motion
Master
Connection
Config
Motion
Master
Pub
Sub
Socket
Motion
Master
Req
Res
Socket
Motor
Phase
Order
Detection
Os
Command
Response
New
Firmware
Package
Filename
Old
Firmware
Package
Filename
Open
Loop
Field
Mode
Os
Command
Response
Open
Phase
Detection
Os
Command
Response
Os
Command
Os
Command
Response
Os
Command
Subcommand
Parameter
Parameters
Comparison
Phase
Inductance
Measurement
Os
Command
Response
Phase
Resistance
Measurement
Os
Command
Response
Pole
Pair
Detection
Os
Command
Response
Position
Profile
Config
Serial
Number
Si
Unit
Velocity
Scale
Sii
Category
Distributed
Clock
Element
Sii
Category
General
Sii
Category
Pdo
Element
Sii
Category
Pdo
Entry
Element
Sii
Category
Sync
Manager
Element
Skipped
Cycles
Counter
Os
Command
Response
Slave
Information
Interface
Smm
Acyclic
Handler
Os
Command
Response
Somanet
Circulo
Variant
Somanet
Product
Somanet
Product
Range
Stack
Info
System
Identification
Os
Command
Response
System
Log
Line
Torque
Constant
Measurement
Os
Command
Response
Torque
Profile
Config
Trigger
Error
Os
Command
Response
UIFeatures
Config
Unit
Converter
Unit
Converters
Use
Internal
Encoder
Velocity
Os
Command
Response
Velocity
Profile
Config
Assembly
Component
Auto
Tuning
Status
Circulo
Encoder
Configuration
Status
Circulo
Encoder
Magnet
Distance
Status
Circulo
Encoder
Narrow
Angle
Calibration
Procedure
Status
Cogging
Torque
Data
Status
Cogging
Torque
Recording
Status
Compute
Auto
Tuning
Gains
Request
Compute
Full
Auto
Tuning
Gains
Request
Config
Parameter
Delete
Device
File
Request
Device
Ci
A402
State
Status
Device
Component
Device
Fault
Reset
Status
Device
File
List
Status
Device
File
Status
Device
Firmware
Installation
Status
Device
Info
Status
Device
Log
Status
Device
Parameter
Address
Value
Device
Parameter
Ids
Device
Parameter
Info
Status
Device
Parameter
Values
Status
Device
Ref
Device
Ref
Obj
Device
Sii
Restore
Status
Device
Stop
Status
Disable
Motion
Controller
Request
Enable
Motion
Controller
Request
Encoder
Shaft
Ethercat
Network
State
Status
Full
Auto
Tuning
Status
Get
Circulo
Encoder
Magnet
Distance
Request
Get
Cogging
Torque
Data
Request
Get
Device
Ci
A402
State
Request
Get
Device
File
List
Request
Get
Device
File
Request
Get
Device
Log
Request
Get
Device
Parameter
Info
Request
Get
Device
Parameter
Values
Request
Get
Ethercat
Network
State
Request
Get
Multi
Device
Parameter
Values
Request
Monitoring
Parameter
Values
Status
Motion
Composer
Flow
Command
Status
Motion
Composer
Flow
Command
Type
Motion
Composer
Flow
Command
Union
Motion
Controller
Status
Multi
Device
Parameter
Values
Status
Narrow
Angle
Calibration
Status
Offset
Detection
Status
Open
Loop
Field
Control
Status
Optional
Os
Command
Errors
Os
Command
Status
Parameter
Address
Parameter
Address
Value
Parameter
Index
Subindex
Parameter
Info
And
Value
Parameter
Type
Value
Parameter
Type
Value
Key
Parameter
Value
Type
Plant
Identification
Status
Product
Category
Product
Family
Product
Group
Request
Status
Request
Status
Message
Reset
Device
Fault
Request
Set
Device
Ci
A402
State
Request
Set
Device
File
Request
Set
Device
Parameter
Values
Request
Set
Ethercat
Network
State
Request
Set
Motion
Controller
Parameters
Request
Set
Multi
Device
Parameter
Values
Request
Set
Signal
Generator
Parameters
Request
Set
System
Client
Timeout
Request
Si
Unit
Velocity
Name
Signal
Generator
Status
Somanet
Circulo
Variant
Id
Somanet
Product
Range
Name
Somanet
Product
Range
Name
All
Start
Circulo
Encoder
Configuration
Request
Start
Circulo
Encoder
Narrow
Angle
Calibration
Procedure
Request
Start
Cogging
Torque
Recording
Request
Start
Device
Firmware
Installation
Request
Start
Device
Sii
Restore
Request
Start
Full
Auto
Tuning
Request
Start
Monitoring
Device
Parameter
Values
Request
Start
Narrow
Angle
Calibration
Request
Start
Offset
Detection
Request
Start
Open
Loop
Field
Control
Request
Start
Os
Command
Request
Start
Plant
Model
Identification
Request
Start
Signal
Generator
Request
Start
System
Identification
Request
Status
Key
Stop
Circulo
Encoder
Narrow
Angle
Calibration
Procedure
Request
Stop
Device
Request
Stop
Full
Auto
Tuning
Request
Stop
Monitoring
Device
Parameter
Values
Request
Stop
Signal
Generator
Request
System
Identification
Status
System
Log
Status
System
Version
Status
UIFeatures
Config
Parameter
Unit
Converter
Id
ECAN_
IDS
ECBN_
IDS
ECDB_
E1_
IDS
ECDL_
IDS
ECDN_
E1_
IDS
ECNN_
IDS
all
Base
Data
Types
base
Data
Types
base
Data
Types
With
Variable
Length
cia402
State
Map
cia402
Transitions
circulo
Encoder
Battery
Mode
Map
controlword
Bits
controlword
Command
Bitmasks
controlword
Command
Options
controlword
Options
device
Parameter
Id
Reg
Exp
disabled
Value
Parameters
dummy
Hardware
Description
File
Content
Template
empty
App
Base64
encoder
Register
Errors
ethercat
Network
State
Options
factory
Reset
Default
Files
To
Keep
filename
Part
Reg
Exp
firmware
Id
Reg
Exp
firmware
Package
Base
Url
homing
Method
Parameters
Map
homing
Procedure
Status
Messages
hrd
Streaming
Os
Command
Errors
integro
Variant
Options
integro
Variant
Pack
Format
kubler
Encoder
Command
Os
Command
Errors
kubler
Encoder
Register
Communication
Read
Os
Command
Errors
kubler
Encoder
Register
Communication
Write
Os
Command
Errors
kubler
Encoder
Register
Value
Meaning
kubler
Encoder
Subcommands
list
Firmware
Packages
Url
modes
Of
Operation
Options
new
Firmware
Package
Filename
Reg
Exp
old
Firmware
Package
Filename
Reg
Exp
open
Loop
Field
Mode
Parameters
open
Phase
Detection
Errors
os
Command
Error
Code
os
Commands
parameter
Address
To
Color
parameter
Id
Reg
Exp
parameter
Value
Type
Options
position
Controller
Type
Options
product
Categories
product
Families
product
Groups
request
Status
Resolver
serial
Number
Pattern
si
Unit
Velocity
Scales
si
Unit
Velocity
Value
smm
Acyclic
Handler
Subcommands
somanet
Circulo
Variants
somanet
Product
Range
Names
somanet
Product
Ranges
somanet
Products
stack
Unlock
Filename
statusword
Bits
supported
Drive
Modes
Bits
system
Identification
Parameters
trigger
Error
Types
unit
Converter
Parameters
unit
Converters
usable
Circulo
Encoder
Port
Product
Ids
value
Type
To
Parameter
Type
Value
Key
Map
web
Socket
Connection
Close
Codes
camel
Case
To
Words
compare
Parameters
compute
Zero
Home
Offset
From
Position
convert
Feed
Constant
Affected
Position
Value
convert
Feed
Constant
Affected
Velocity
Value
convert
Motion
Master
Message
To
Logger
Context
convert
Rgb
To
Led
Color
convert
Si
Unit
Velocity
Affected
Value
convert
Velocity
Affected
Value
create
Commutation
Offset
Measurement
Os
Command
create
Controlword
Command
create
Encoder
Register
Communication
Os
Command
create
Homing
Procedure
Status
create
Hrd
Streaming
Os
Command
create
Ic
Mu
Calibration
Mode
Os
Command
create
Ignore
Biss
Status
Bits
Os
Command
create
Kubler
Encoder
Command
Check
Firmware
Update
Size
Os
Command
create
Kubler
Encoder
Command
Write
Firmware
Os
Command
create
Kubler
Encoder
Os
Command
create
Kubler
Encoder
Register
Communication
Os
Command
create
Motion
Master
Client
create
Motor
Phase
Order
Detection
Os
Command
create
Open
Loop
Field
Mode
Os
Command
create
Open
Phase
Detection
Os
Command
create
Os
Command
Typed
Array
create
Pdo
Parameter
Values
create
Phase
Inductance
Measurement
Os
Command
create
Phase
Resistance
Measurement
Os
Command
create
Plain
Object
From
Motion
Master
Message
create
Pole
Pair
Detection
Os
Command
create
Random
Color
create
Skipped
Cycles
Counter
Os
Command
create
Smm
Acyclic
Handler
Os
Command
create
Smm
Acyclic
Handler
Read
Smm
Parameter
Os
Command
create
System
Identification
Os
Command
create
Torque
Constant
Measurement
Os
Command
create
Trigger
Error
Os
Command
create
Use
Internal
Encoder
Velocity
Os
Command
decode
Text
Content
device
Components
Match
diff
System
Log
Contents
difference
Parameters
ensure
Device
Ref
extend
Status
extract
Device
Components
From
Old
Firmware
Package
Filename
extract
Device
Components
From
Stack
Info
extract
Firmware
Id
extract
Firmware
Version
From
Firmware
Package
Filename
fill
Pdo
Parameters
With
Mapping
Entries
filter
Rx
Pdo
Parameters
filter
Tx
Pdo
Parameters
find
Base
Data
Type
By
Index
find
Duplicates
find
Somanet
Product
By
Id
find
Somanet
Product
Range
By
Product
Id
firmware
Version
Satisfies
get
All
Components
From
Hardware
Description
get
Api
Identifier
From
Hardware
Description
get
Cia402
State
get
Circulo
Encoder
Battery
Mode
Default
Value
get
Circulo
Encoder
Battery
Mode
Options
get
Command
From
Controlword
get
Device
Ref
From
Device
Ref
Obj
get
Encoder
Port
Name
get
Firmware
Package
Url
get
Id
From
Hardware
Description
get
Map
Key
By
Value
get
Name
From
Hardware
Description
get
Number
Of
Encoder
Ports
By
Product
Id
get
Parameter
Type
Value
get
Parameter
Type
Value
Default
get
Parameter
Value
get
Serial
Number
From
Hardware
Description
get
Unit
Converter
For
Parameter
intersection
Parameters
intersection
Parameters
With
Different
Values
is
Array
Of
Device
Serial
Numbers
is
Calibration
Firmware
is
Device
Parameter
Id
is
Device
Ref
is
Encoder
Configuration
Firmware
is
Encoder
Port
Internal
is
Encoder
Port
Usable
is
Filename
Part
is
Firmware
Package
Filename
Compatible
With
Device
is
Firmware
Version
In
Range
is
Internal
Encoder
Port
Usable
is
Internal
Limit
Active
is
New
Firmware
Package
Filename
is
Object
Of
Device
Serial
Number
To
Values
is
Old
Firmware
Package
Filename
is
Os
Command
Response
is
Parameter
Id
is
Parameter
Value
Disabled
is
Pdo
Index
is
Product
Id
Of
Type
is
Rx
Pdo
Index
is
Smm
Index
is
Somanet
Product
Id
In
Range
is
Stack
Info
is
Tx
Pdo
Index
is
Valid
Device
Ref
is
Valid
Device
Ref
Obj
make
Device
Parameter
Id
make
Device
Ref
Obj
make
Device
Serial
Number
From
Address
make
Parameter
Id
map
Encoder
Register
Value
To
Errors
map
Monitoring
Parameter
Values
Status
Message
To
Device
Parameters
map
Monitoring
Parameter
Values
Status
Message
To
Parameter
Values
map
Os
Command
Response
map
Parameter
To
Pdo
Sub
Item
Value
map
Parameter
Type
Value
To
Object
map
Value
Type
To
Bit
Size
parameters
Compare
Fn
parse
Device
Log
parse
Device
Log
Content
parse
Firmware
Id
parse
Integro
Encoder
Firmware
Version
parse
Integro
Firmware
Version
parse
Integro
Variant
Buffer
parse
New
Firmware
Package
Filename
parse
Old
Firmware
Package
Filename
parse
Os
Command
Response
parse
Parameter
Value
parse
Pdo
Sub
Item
Value
parse
Serial
Number
parse
Sii
Buffer
parse
System
Log
Content
parse
System
Log
Line
remove
Invalid
Build
Metadata
From
Firmware
Version
resolve
After
resolve
Installable
Firmwares
resolve
Parameter
Index
And
Subindex
resolve
Sii
Category
Type
select
Motion
Master
Message
By
Topic
select
Motion
Master
Message
Status
By
Key
select
Motion
Master
Message
Status
By
Message
Id
set
Bit
High
set
Bit
Low
split
Device
Parameter
Id
split
Parameter
Id
statusword
To
Homing
Status
to
Fixed
Format
transform
Motion
Master
Message
To
Status
unpack
Integro
Variant
Buffer
Generated using
TypeDoc