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

Responses

200

Successful Response

application/json

devstringRequired

circuitstringRequired

valueinteger · enumRequiredPossible values:

counterintegerRequired

counter_modestring · enumRequiredPossible values:

modestring · enumRequiredPossible values:

debounceintegerOptionalDefault: 50

get

/controller/di

HTTPcURLJavaScriptPython

GET /controller/di HTTP/1.1
Host: localhost:8080
Accept: */*

200

Successful Response

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

Get Digital Input

get

Path parameters

circuitstringRequired

Responses

200

Successful Response

application/json

devstringRequired

circuitstringRequired

valueinteger · enumRequiredPossible values:

counterintegerRequired

counter_modestring · enumRequiredPossible values:

modestring · enumRequiredPossible values:

debounceintegerOptionalDefault: 50

422

Validation Error

application/json

get

/controller/di/{circuit}

HTTPcURLJavaScriptPython

GET /controller/di/{circuit} HTTP/1.1
Host: localhost:8080
Accept: */*

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

Set Digital Input

post

Path parameters

circuitstringRequired

Body

application/json

counterintegerRequired

counter_modestring · enumOptionalDefault: EnabledPossible values:

modestring · enumOptionalDefault: SimplePossible values:

debounceintegerOptionalDefault: 50

Responses

200

Successful Response

application/json

devstringRequired

circuitstringRequired

valueinteger · enumRequiredPossible values:

counterintegerRequired

counter_modestring · enumRequiredPossible values:

modestring · enumRequiredPossible values:

debounceintegerOptionalDefault: 50

422

Validation Error

application/json

post

/controller/di/{circuit}

HTTPcURLJavaScriptPython

POST /controller/di/{circuit} HTTP/1.1
Host: localhost:8080
Content-Type: application/json
Accept: */*
Content-Length: 68

{
  "counter": 1,
  "counter_mode": "Enabled",
  "mode": "Simple",
  "debounce": 50
}

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

Set All Digital Inputs

post

Body

application/json

counterintegerRequired

counter_modestring · enumOptionalDefault: EnabledPossible values:

modestring · enumOptionalDefault: SimplePossible values:

debounceintegerOptionalDefault: 50

Responses

200

Successful Response

application/json

devstringRequired

circuitstringRequired

valueinteger · enumRequiredPossible values:

counterintegerRequired

counter_modestring · enumRequiredPossible values:

modestring · enumRequiredPossible values:

debounceintegerOptionalDefault: 50

422

Validation Error

application/json

post

/controller/di

HTTPcURLJavaScriptPython

POST /controller/di HTTP/1.1
Host: localhost:8080
Content-Type: application/json
Accept: */*
Content-Length: 68

{
  "counter": 1,
  "counter_mode": "Enabled",
  "mode": "Simple",
  "debounce": 50
}

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

List All Digital Outputs

get

Responses

200

Successful Response

application/json

devstringRequired

circuitstringRequired

pwm_freqnumberRequired

pwm_dutyinteger · max: 100Required

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

valueintegerRequired

modestring · enumRequiredPossible values:

get

/controller/do

HTTPcURLJavaScriptPython

GET /controller/do HTTP/1.1
Host: localhost:8080
Accept: */*

200

Successful Response

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

Get Digital Output

get

Path parameters

circuitstringRequired

Responses

200

Successful Response

application/json

devstringRequired

circuitstringRequired

pwm_freqnumberRequired

pwm_dutyinteger · max: 100Required

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

valueintegerRequired

modestring · enumRequiredPossible values:

422

Validation Error

application/json

get

/controller/do/{circuit}

HTTPcURLJavaScriptPython

GET /controller/do/{circuit} HTTP/1.1
Host: localhost:8080
Accept: */*

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

Set Digital Output

post

Path parameters

circuitstringRequired

Body

application/json

pwm_freqnumberRequired

pwm_dutyinteger · max: 100Required

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

valueintegerRequired

Responses

200

Successful Response

application/json

devstringRequired

circuitstringRequired

pwm_freqnumberRequired

pwm_dutyinteger · max: 100Required

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

valueintegerRequired

modestring · enumRequiredPossible values:

422

Validation Error

application/json

post

/controller/do/{circuit}

HTTPcURLJavaScriptPython

POST /controller/do/{circuit} HTTP/1.1
Host: localhost:8080
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "pwm_freq": 1,
  "pwm_duty": 1,
  "value": 1
}

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

Set All Digital Outputs

post

Body

application/json

pwm_freqnumberRequired

pwm_dutyinteger · max: 100Required

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

valueintegerRequired

Responses

200

Successful Response

application/json

devstringRequired

circuitstringRequired

pwm_freqnumberRequired

pwm_dutyinteger · max: 100Required

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

valueintegerRequired

modestring · enumRequiredPossible values:

422

Validation Error

application/json

post

/controller/do

HTTPcURLJavaScriptPython

POST /controller/do HTTP/1.1
Host: localhost:8080
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "pwm_freq": 1,
  "pwm_duty": 1,
  "value": 1
}

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