slave configuration slave

Slave Schema

https://raw.githubusercontent.com/wiki/STECHOQ/etherlab-nodejs/schema/slave-configuration.schema.json#/items

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	No	Forbidden	Forbidden	none	slave-configuration.schema.json*

items Type

object (Slave)

items Examples

{
  "alias": 0,
  "position": 0,
  "vendor_id": "0x00000002",
  "product_code": "0x044c2c52"
}

{
  "alias": 0,
  "position": 1,
  "vendor_id": "0x00000002",
  "product_code": "0x18503052",
  "syncs": [
    {
      "index": 3,
      "watchdog_enabled": false,
      "pdos": [
        {
          "index": "0x1a00",
          "entries": [
            {
              "index": "0x6000",
              "subindex": "0x01",
              "size": 16,
              "add_to_domain": true,
              "swap_endian": true,
              "signed": false
            }
          ]
        }
      ]
    }
  ],
  "parameters": [
    {
      "index": "0x8000",
      "subindex": "0x04",
      "size": 32,
      "value": "0x55"
    }
  ]
}

items Properties

Property	Type	Required	Nullable	Defined by
alias	Multiple	Required	cannot be null	SlavesConfiguration
position	Multiple	Required	cannot be null	SlavesConfiguration
vendor_id	Multiple	Required	cannot be null	SlavesConfiguration
product_code	Multiple	Required	cannot be null	SlavesConfiguration
syncs	array	Optional	cannot be null	SlavesConfiguration
parameters	array	Optional	cannot be null	SlavesConfiguration

alias

Slave's alias number (in integer or hexadecimal string).

alias

• is required

• Type: any of the folllowing: integer or string (Details)

• cannot be null

• defined in: SlavesConfiguration

alias Type

any of the folllowing: integer or string (Details)

alias Constraints

pattern: the string must match the following regular expression:

^0x[0-9a-fA-F]+

try pattern

alias Examples

0

position

Slave's position relative to master (in integer or hexadecimal string).

position

• is required

• Type: any of the folllowing: integer or string (Details)

• cannot be null

• defined in: SlavesConfiguration

position Type

any of the folllowing: integer or string (Details)

position Constraints

pattern: the string must match the following regular expression:

^0x[0-9a-fA-F]+

try pattern

position Examples

0

1

vendor_id

Slave's vendor id (in integer or hexadecimal string).

vendor_id

• is required

• Type: any of the folllowing: integer or string (Details)

• cannot be null

• defined in: SlavesConfiguration

vendor_id Type

any of the folllowing: integer or string (Details)

vendor_id Constraints

pattern: the string must match the following regular expression:

^0x[0-9a-fA-F]+

try pattern

vendor_id Examples

"0x00000002"

2

product_code

Slave's product code (in integer or hexadecimal string).

product_code

• is required

• Type: any of the folllowing: integer or string (Details)

• cannot be null

• defined in: SlavesConfiguration

product_code Type

any of the folllowing: integer or string (Details)

product_code Constraints

pattern: the string must match the following regular expression:

^0x[0-9a-fA-F]+

try pattern

product_code Examples

"0x0fa43052"

262418514

syncs

SM configurtion. Omit this field if the slave is a bus coupler, such as EK1100

syncs

• is optional

• Type: object[] (SyncManager)

• cannot be null

• defined in: SlavesConfiguration

syncs Type

object[] (SyncManager)

parameters

List of Startup Parameters to be set before running ethercat instance.

parameters

• is optional

• Type: object[] (startupParameters)

• cannot be null

• defined in: SlavesConfiguration

parameters Type

object[] (startupParameters)