Digital I/O

Digital inputs receive signals from external devices like switches, sensors, or push buttons, indicating whether a condition is active or inactive (e.g., a door is open or closed). Digital outputs enable the PLC to control devices such as relays, lights, or solenoids by sending on/off signals to activate or deactivate them. These I/O channels are essential for processes that rely on clear, binary decisions, ensuring reliable control of equipment and systems in automated operations. The main difference between digital I/O and analog I/O is that digital I/O provides binary values (on/off, true/false, ...). Digital I/O API provides interface for controlling all digital inputs and outputs on your controller.

API Reference

List All Digital Inputs

get

/controller/di

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://robopipe-1.local/controller/di'

200

200

[
  {
    "dev": "text",
    "circuit": "text",
    "counter": 1,
    "counter_mode": "Enabled",
    "mode": "Simple",
    "debounce": 50,
    "value": 0,
    "counter_modes": [
      "Enabled"
    ],
    "modes": [
      "Simple"
    ]
  }
]

Successful Response

Get Digital Input

get

/controller/di/{circuit}

Path parameters

circuitCircuitrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://robopipe-1.local/controller/di/{circuit}'

200

422

200

{
  "dev": "text",
  "circuit": "text",
  "counter": 1,
  "counter_mode": "Enabled",
  "mode": "Simple",
  "debounce": 50,
  "value": 0,
  "counter_modes": [
    "Enabled"
  ],
  "modes": [
    "Simple"
  ]
}

Successful Response

Set Digital Input

post

/controller/di/{circuit}

Path parameters

circuitCircuitrequired

Body

counterCounterrequired

counter_modeDigitalInputCounterMode

Options: Enabled, Disabled

modeDigitalInputMode

Options: Simple, DirectSwitch

debounceDebounce

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://robopipe-1.local/controller/di/{circuit}' \
  --header 'Content-Type: application/json' \
  --data '{"counter":1,"counter_mode":"Enabled","mode":"Simple","debounce":50}'

200

422

200

{
  "dev": "text",
  "circuit": "text",
  "counter": 1,
  "counter_mode": "Enabled",
  "mode": "Simple",
  "debounce": 50,
  "value": 0,
  "counter_modes": [
    "Enabled"
  ],
  "modes": [
    "Simple"
  ]
}

Successful Response

Set All Digital Inputs

post

/controller/di

Body

counterCounterrequired

counter_modeDigitalInputCounterMode

Options: Enabled, Disabled

modeDigitalInputMode

Options: Simple, DirectSwitch

debounceDebounce

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://robopipe-1.local/controller/di' \
  --header 'Content-Type: application/json' \
  --data '{"counter":1,"counter_mode":"Enabled","mode":"Simple","debounce":50}'

200

422

200

[
  {
    "dev": "text",
    "circuit": "text",
    "counter": 1,
    "counter_mode": "Enabled",
    "mode": "Simple",
    "debounce": 50,
    "value": 0,
    "counter_modes": [
      "Enabled"
    ],
    "modes": [
      "Simple"
    ]
  }
]

Successful Response

List All Digital Outputs

get

/controller/do

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://robopipe-1.local/controller/do'

200

200

[
  {
    "dev": "text",
    "circuit": "text",
    "pwm_freq": 1,
    "pwm_duty": 1,
    "value": 1,
    "mode": "Simple",
    "modes": [
      "Simple"
    ]
  }
]

Successful Response

Get Digital Output

get

/controller/do/{circuit}

Path parameters

circuitCircuitrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://robopipe-1.local/controller/do/{circuit}'

200

422

200

{
  "dev": "text",
  "circuit": "text",
  "pwm_freq": 1,
  "pwm_duty": 1,
  "value": 1,
  "mode": "Simple",
  "modes": [
    "Simple"
  ]
}

Successful Response

Set Digital Output

post

/controller/do/{circuit}

Path parameters

circuitCircuitrequired

Body

pwm_freqPwm Freqrequired

pwm_dutyPwm Dutyrequired

Mutually exclusive with value. Value must be between 0 and 100

valueValuerequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://robopipe-1.local/controller/do/{circuit}' \
  --header 'Content-Type: application/json' \
  --data '{"pwm_freq":1,"pwm_duty":1,"value":1}'

200

422

200

{
  "dev": "text",
  "circuit": "text",
  "pwm_freq": 1,
  "pwm_duty": 1,
  "value": 1,
  "mode": "Simple",
  "modes": [
    "Simple"
  ]
}

Successful Response

Set All Digital Outputs

post

/controller/do

Body

pwm_freqPwm Freqrequired

pwm_dutyPwm Dutyrequired

Mutually exclusive with value. Value must be between 0 and 100

valueValuerequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://robopipe-1.local/controller/do' \
  --header 'Content-Type: application/json' \
  --data '{"pwm_freq":1,"pwm_duty":1,"value":1}'

200

422

200

[
  {
    "dev": "text",
    "circuit": "text",
    "pwm_freq": 1,
    "pwm_duty": 1,
    "value": 1,
    "mode": "Simple",
    "modes": [
      "Simple"
    ]
  }
]

Successful Response