Example configurations

SRCP to EPC over ISM

1). Create the configuration

Code
curl --request POST \
  --url https://platform.fortrobotics.com/v1/organizations/:orgId/configurations \
  --header 'Authorization: Bearer zpka_MY_API_KEY_546c386c1a8cdc0a85_9ccb598f' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "SRCP to EPC over ISM",
  "ismNetworkId": 1,
  "ismTxPower": "HIGH",
  "ismTxChannel": 3,
  "canMode": "j1939",
  "canKBitrate": "BITRATE_250000",
  "timeoutConfiguration": 1000
}'

Note: Copy the id of the configuration that is created. It will be used when adding devices to it.

2). Add the SRCP as a sender

Code
curl --request POST \
  --url https://platform.fortrobotics.com/v1/organizations/:orgId/configurations/:id/devices \
  --header 'Authorization: Bearer zpka_MY_API_KEY_546c386c1a8cdc0a85_9ccb598f' \
  --header 'Content-Type: application/json' \
  --data '
{
  "serialNumber": "VWHUMH7W6Y",
  "deviceConfigurationType": "Sender",
  "commInterface": "ISM",
  "inputConfiguration1": "NOT_USED",
  "inputConfiguration2": "NOT_USED"
 }
 '

3). Add the EPC as a receiver

Code
curl --request POST \
  --url https://platform.fortrobotics.com/v1/organizations/:orgId/configurations/:id/devices \
  --header 'Authorization: Bearer zpka_MY_API_KEY_546c386c1a8cdc0a85_9ccb598f' \
  --header 'Content-Type: application/json' \
  --data '
{
  "serialNumber": "GQKRGLTPV3",
  "deviceConfigurationType": "Receiver",
  "commInterface": "ISM",
  "inputConfiguration1": "NOT_USED",
  "inputConfiguration2": "NOT_USED"
 }
 '

4). Get EPC firmware

Code
curl --request GET \
  --url https://platform.fortrobotics.com/v1/organizations/:orgId/devices/:serialNumber/firmware \
  --header 'Authorization: Bearer zpka_MY_API_KEY_546c386c1a8cdc0a85_9ccb598f'

5). Get EPC configuration

Code
curl --request GET \
  --url https://platform.fortrobotics.com/v1/organizations/:orgId/devices/:serialNumber/configuration-file \
  --header 'Authorization: Bearer zpka_MY_API_KEY_546c386c1a8cdc0a85_9ccb598f'

6). Delete the configuration

Code
curl --request DELETE \
  --url https://platform.fortrobotics.com/v1/organizations/:orgId/configurations/:id \
  --header 'Authorization: Bearer zpka_MY_API_KEY_546c386c1a8cdc0a85_9ccb598f'

EPC to EPC over Ethernet

1). First create the configuration

Code
curl --request POST \
  --url https://platform.fortrobotics.com/v1/organizations/:orgId/configurations \
  --header 'Authorization: Bearer zpka_MY_API_KEY_546c386c1a8cdc0a85_9ccb598f' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "EPC to EPC over Ethernet",
  "startingIpAddress": "192.168.20.1",
  "canMode": "J1939",
  "canKBitrate": "BITRATE_250000",
  "timeoutConfiguration": 5000
}
'

NOTE: Copy the id returned and set in the following URL after 'configurations'

2). Add the EPC as a sender

Code
curl --request POST \
  --url https://platform.fortrobotics.com/v1/organizations/:orgId/configurations/:id/devices \
  --header 'Authorization: Bearer zpka_MY_API_KEY_546c386c1a8cdc0a85_9ccb598f' \
  --header 'Content-Type: application/json' \
  --data '
{
  "serialNumber": "UBNYUXMG8F",
  "deviceConfigurationType": "Sender",
  "commInterface": "Ethernet",
  "inputConfiguration1": "ESTOP_TYPE_SWITCH",
  "inputConfiguration2": "NOT_USED",
  "ipAddress": "192.168.20.10",
  "ethNetmask": "255.255.255.0",
  "ethGateway": "192.168.20.99",
  "ethNameservers": ["192.168.20.100"]
}
'

3). Add the EPC as a receiver

Code
curl --request POST \
  --url https://platform.fortrobotics.com/v1/organizations/:orgId/configurations/:id/devices \
  --header 'Authorization: Bearer zpka_MY_API_KEY_546c386c1a8cdc0a85_9ccb598f' \
  --header 'Content-Type: application/json' \
  --data '
{
  "serialNumber": "EPCUSD0021",
  "deviceConfigurationType": "Receiver",
  "commInterface": "Ethernet",
  "inputConfiguration1": "ESTOP_TYPE_SWITCH",
  "inputConfiguration2": "NOT_USED",
  "ipAddress": "192.168.20.11",
  "ethNetmask": "255.255.255.0",
  "ethGateway": "192.168.20.99",
  "ethNameservers": ["192.168.20.100"]
}
'

EPC to EPC (1 to N) Over Ethernet

1). First create the configuration

Code
curl --request POST \
  --url https://platform.fortrobotics.com/v1/organizations/:orgId/configurations \
  --header 'Authorization: Bearer zpka_MY_API_KEY_546c386c1a8cdc0a85_9ccb598f' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "EPC to EPC 1:N over Ethernet",
  "startingIpAddress": "192.168.20.1",
  "canMode": "none",
  "timeoutConfiguration": 5000
}
'

NOTE: Copy the id returned and set in the following URL after 'configurations'

2). Add the EPC as a sender

Code
curl --request POST \
  --url https://platform.fortrobotics.com/v1/organizations/:orgId/configurations/:id/devices \
  --header 'Authorization: Bearer zpka_MY_API_KEY_546c386c1a8cdc0a85_9ccb598f' \
  --header 'Content-Type: application/json' \
  --data '
{
  "serialNumber": "UBNYUXMG8F",
  "deviceConfigurationType": "Sender",
  "commInterface": "Ethernet",
  "inputConfiguration1": "ESTOP_TYPE_SWITCH",
  "inputConfiguration2": "NOT_USED",
  "ipAddress": "192.168.20.10",
  "ethNetmask": "255.255.255.0",
  "ethGateway": "192.168.20.99",
  "ethNameservers": ["192.168.20.100"]
}
'

3). Add an EPC Receiver

Code
curl --request POST \
  --url https://platform.fortrobotics.com/v1/organizations/:orgId/configurations/:id/devices \
  --header 'Authorization: Bearer zpka_MY_API_KEY_546c386c1a8cdc0a85_9ccb598f' \
  --header 'Content-Type: application/json' \
  --data '
{
  "serialNumber": "EPCUSD0021",
  "deviceConfigurationType": "Receiver",
  "commInterface": "Ethernet",
  "inputConfiguration1": "ESTOP_TYPE_SWITCH",
  "inputConfiguration2": "NOT_USED",
  "ipAddress": "192.168.20.11",
  "ethNetmask": "255.255.255.0",
  "ethGateway": "192.168.1.99",
  "ethNameservers": ["192.168.1.100"]
}
'

4). Add a second EPC receiver

Code
curl --request POST \
  --url https://platform.fortrobotics.com/v1/organizations/:orgId/configurations/:id/devices \
  --header 'Authorization: Bearer zpka_MY_API_KEY_546c386c1a8cdc0a85_9ccb598f' \
  --header 'Content-Type: application/json' \
  --data '
{
  "serialNumber": "EPCUSD0008",
  "deviceConfigurationType": "Receiver",
  "commInterface": "Ethernet",
  "inputConfiguration1": "ESTOP_TYPE_SWITCH",
  "inputConfiguration2": "NOT_USED",
  "ipAddress": "192.168.20.12",
  "ethNetmask": "255.255.255.0",
  "ethGateway": "192.168.20.99",
  "ethNameservers": ["192.168.20.100"]
}
'

EPC to NSCP over Ethernet

1). Create the configuration

Code
curl --request POST \
  --url https://platform.fortrobotics.com/v1/organizations/:orgId/configurations \
  --header 'Authorization: Bearer zpka_MY_API_KEY_546c386c1a8cdc0a85_9ccb598f' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "EPC to NSCP over Ethernet",
  "startingIpAddress": "192.168.20.1",
  "timeoutConfiguration": 3000,
  "canMode": "none"
}
'

2). Add the EPC as a sender

Code
curl --request POST \
  --url https://platform.fortrobotics.com/v1/organizations/:orgId/configurations/:id/devices \
  --header 'Authorization: Bearer zpka_MY_API_KEY_546c386c1a8cdc0a85_9ccb598f' \
  --header 'Content-Type: application/json' \
  --data '
{
  "serialNumber": "UBNYUXMG8F",
  "deviceConfigurationType": "Sender",
  "commInterface": "Ethernet",
  "inputConfiguration1": "ESTOP_TYPE_SWITCH",
  "inputConfiguration2": "NOT_USED",
  "ipAddress": "192.168.20.10",
  "ethNetmask": "255.255.255.0",
  "ethGateway": "192.168.1.99",
  "ethNameservers": ["192.168.1.100"]
}
'

3). Add the NSCP as a receiver. Serial 0 port will be used with the FORT SDK and serial 1 port as the data output control

Code
curl --request POST \
  --url https://platform.fortrobotics.com/v1/organizations/:orgId/configurations/:id/devices \
  --header 'Authorization: Bearer zpka_MY_API_KEY_546c386c1a8cdc0a85_9ccb598f' \
  --header 'Content-Type: application/json' \
  --data '
{
  "serialNumber": "NSCUSD0020",
  "deviceConfigurationType": "Receiver",
  "commInterface": "Ethernet",
  "inputConfiguration1": "ESTOP_TYPE_SWITCH",
  "inputConfiguration2": "NOT_USED",
  "ipAddress": "192.168.20.11",
  "ethNetmask": "255.255.255.0",
  "ethGateway": "192.168.20.99",
  "ethNameservers": ["192.168.20.100"],
  "serial0Usage": "comms",
  "serial1Usage": "control",
  "stopCategory": "CAT0"
}
'

SRCP to EPC over Bluetooth

1). Create the configuration

Code
curl --request POST \
  --url https://platform.fortrobotics.com/v1/organizations/:orgId/configurations \
  --header 'Authorization: Bearer zpka_MY_API_KEY_546c386c1a8cdc0a85_9ccb598f' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "SRCP to EPC over Bluetooth",
  "timeoutConfiguration": 5000
}
'

2). Create the SRCP Sender

Code
curl --request POST \
  --url https://platform.fortrobotics.com/v1/organizations/:orgId/configurations/:id/devices \
  --header 'Authorization: Bearer zpka_MY_API_KEY_546c386c1a8cdc0a85_9ccb598f' \
  --header 'Content-Type: application/json' \
  --data '
{
  "serialNumber": "VWHUMH7W6Y",
  "deviceConfigurationType": "Sender",
  "commInterface": "ble",
  "inputConfiguration1": "NOT_USED",
  "inputConfiguration2": "NOT_USED"
 }
 '

3). Add an EPC Receiver

Code
curl --request POST \
  --url https://platform.fortrobotics.com/v1/organizations/:orgId/configurations/:id/devices \
  --header 'Authorization: Bearer zpka_MY_API_KEY_546c386c1a8cdc0a85_9ccb598f' \
  --header 'Content-Type: application/json' \
  --data '
{
  "serialNumber": "UD7GYH39WP",
  "deviceConfigurationType": "Receiver",
  "commInterface": "ble",
  "inputConfiguration1": "NOT_USED",
  "inputConfiguration2": "NOT_USED"
 }
 '

Global E-Stop SRCP + EPC to EPC

1). Create the configuration

Code
curl --request POST \
  --url https://platform.fortrobotics.com/v1/organizations/:orgId/configurations \
  --header 'Authorization: Bearer zpka_MY_API_KEY_546c386c1a8cdc0a85_9ccb598f' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Global E-Stop SRCP + EPC to EPC",
  "canMode": "j1939",
  "canKBitrate": "BITRATE_250000",
  "timeoutConfiguration": 3000
}
'

2). Create the SRCP Sender

Code
curl --request POST \
  --url https://platform.fortrobotics.com/v1/organizations/:orgId/configurations/:id/devices \
  --header 'Authorization: Bearer zpka_MY_API_KEY_546c386c1a8cdc0a85_9ccb598f' \
  --header 'Content-Type: application/json' \
  --data '
{
  "serialNumber": "VWHUMH7W6Y",
  "deviceConfigurationType": "Sender",
  "commInterface": "ble",
  "inputConfiguration1": "NOT_USED",
  "inputConfiguration2": "NOT_USED"
 }
 '

3). Create the Global E-Stop Sender

Code
curl --request POST \
  --url https://platform.fortrobotics.com/v1/organizations/:orgId/configurations/:id/devices \
  --header 'Authorization: Bearer zpka_MY_API_KEY_546c386c1a8cdc0a85_9ccb598f' \
  --header 'Content-Type: application/json' \
  --data '
{
  "serialNumber": "WTPP699CTU",
  "deviceConfigurationType": "EStopSender",
  "commInterface": "ethernet",
  "inputConfiguration1": "NOT_USED",
  "inputConfiguration2": "NOT_USED",
  "inputConfiguration3": "ESTOP_TYPE_SWITCH",
  "ipAddress": "192.168.20.51",
  "ethNetmask": "255.255.255.0",
  "ethGateway": "192.168.20.99",
  "ethNameservers": ["192.168.20.100"]
 }
'

4). Add an EPC Receiver

Code
curl --request POST \
  --url https://platform.fortrobotics.com/v1/organizations/:orgId/configurations/:id/devices \
  --header 'Authorization: Bearer zpka_MY_API_KEY_546c386c1a8cdc0a85_9ccb598f' \
  --header 'Content-Type: application/json' \
  --data '
{
  "serialNumber": "UD7GYH39WP",
  "deviceConfigurationType": "Receiver",
  "commInterface": "ethernet,ble",
  "inputConfiguration1": "NOT_USED",
  "inputConfiguration2": "NOT_USED",
  "ipAddress": "192.168.20.50",
  "ethNetmask": "255.255.255.0",
  "ethGateway": "192.168.20.99",
  "ethNameservers": ["192.168.20.100"]
 }
 '