# Device I/O

Some Zaber devices feature I/O capabilities that are represented in the library by [`DeviceIO`](https://software.zaber.com/motion-library/api/py/ascii/deviceio.md) class.
You can find an instance of [`DeviceIO`](https://software.zaber.com/motion-library/api/py/ascii/deviceio.md) under the [`io`](https://software.zaber.com/motion-library/api/py/ascii/device.md#io) property of a device instance.
I/O allows for a device to interact with external circuitry.
This is useful for applications that require synchronization with other components.

Each individual I/O connection is referred to as a channel.

There are four types of channels: analog output, analog input, digital output, and digital input.
A device may have none, some, or all of these channel types. There may also be multiple channels of a certain type.
Information on the number and type of I/O channels on a particular device
can be found using the [`get_channels_info`](https://software.zaber.com/motion-library/api/py/ascii/deviceio.md#getchannelsinfo) method.

In the example below, the device is queried for information on available channels, and the number of channels available for each type is printed.

**JavaScript:**

```js
const ioInfo = await device.io.getChannelsInfo();

console.log('Number of analog outputs:', ioInfo.numberAnalogOutputs);
console.log('Number of analog inputs:', ioInfo.numberAnalogInputs);
console.log('Number of digital outputs:', ioInfo.numberDigitalOutputs);
console.log('Number of digital inputs:', ioInfo.numberDigitalInputs);
```

**Python:**

```py
io_info = device.io.get_channels_info()

print("Number of analog outputs:", io_info.number_analog_outputs)
print("Number of analog inputs:", io_info.number_analog_inputs)
print("Number of digital outputs:", io_info.number_digital_outputs)
print("Number of digital inputs:", io_info.number_digital_inputs)
```

**C#:**

```cs
var ioInfo = device.IO.GetChannelsInfo();

Console.WriteLine("Number of analog outputs: {0}", ioInfo.NumberAnalogOutputs);
Console.WriteLine("Number of analog inputs: {0}", ioInfo.NumberAnalogInputs);
Console.WriteLine("Number of digital outputs: {0}", ioInfo.NumberDigitalOutputs);
Console.WriteLine("Number of digital inputs: {0}", ioInfo.NumberDigitalInputs);
```

**Java:**

```java
DeviceIOInfo ioInfo = device.getIO().getChannelsInfo();

System.out.println("Number of analog outputs: " + ioInfo.getNumberAnalogOutputs());
System.out.println("Number of analog inputs: " + ioInfo.getNumberAnalogInputs());
System.out.println("Number of digital outputs: " + ioInfo.getNumberDigitalOutputs());
System.out.println("Number of digital inputs: " + ioInfo.getNumberDigitalInputs());
```

**MATLAB (legacy):**

```matlabjava
ioInfo = device.getIO().getChannelsInfo();

fprintf('Number of analog outputs: %d.\n', ioInfo.getNumberAnalogOutputs());
fprintf('Number of analog inputs: %d.\n', ioInfo.getNumberAnalogInputs());
fprintf('Number of digital outputs: %d.\n', ioInfo.getNumberDigitalOutputs());
fprintf('Number of digital inputs: %d.\n', ioInfo.getNumberDigitalInputs());
```

**MATLAB:**

```matlab
ioInfo = device.IO.getChannelsInfo();

fprintf('Number of analog outputs: %d.\n', ioInfo.NumberAnalogOutputs);
fprintf('Number of analog inputs: %d.\n', ioInfo.NumberAnalogInputs);
fprintf('Number of digital outputs: %d.\n', ioInfo.NumberDigitalOutputs);
fprintf('Number of digital inputs: %d.\n', ioInfo.NumberDigitalInputs);
```

**C++:**

```cpp
DeviceIOInfo ioInfo = device.getIO().getChannelsInfo();

std::cout << "Number of analog outputs: " << ioInfo.getNumberAnalogOutputs() << std::endl;
std::cout << "Number of analog inputs: " << ioInfo.getNumberAnalogInputs() << std::endl;
std::cout << "Number of digital outputs: " << ioInfo.getNumberDigitalOutputs() << std::endl;
std::cout << "Number of digital inputs: " << ioInfo.getNumberDigitalInputs() << std::endl;
```

**LabView:**

![LabView](https://software.zaber.com/dev-portal/motion-library/docs/guides/device_features/device_io/device_io_labview.jpg)

The library allows you to read any of the channels available on a device. You may either read all channels of a particular type at once, or read only one channel of a particular type at once.
You can also write to any of the output channels. Similar to reading, you may either write to all channels of a particular type at once, or write to only one channel of a particular type at once.

When reading digital channel types, a value of `false` indicates the channel is open or low (depending on the type of digital connection), while a value of `true` indicates that the channel is closed or high. When writing digital channel types, a value of `OFF` sets the channel open or low, a value of `ON` sets the channel closed or high, a value of `TOGGLE` switches the state of the channel, and a value of `KEEP` does not modify the state of the channel.
For analog channel types, the value is the voltage present on the channel.

The next example demonstrates reading the value of digital input channel 1.

**JavaScript:**

```js
const digitalInput1 = await device.io.getDigitalInput(1);
console.log(`Value of digital input channel 1: ${digitalInput1}`);
```

**Python:**

```py
digital_input_1 = device.io.get_digital_input(1)
print("Value of digital input channel 1:", digital_input_1)
```

**C#:**

```cs
var digitalInput1 = device.IO.GetDigitalInput(1);
Console.WriteLine("Value of digital input channel 1: {0}", digitalInput1);
```

**Java:**

```java
boolean digitalInput1 = device.getIO().getDigitalInput(1);
System.out.println("Value of digital input channel 1: " + digitalInput1);
```

**MATLAB (legacy):**

```matlabjava
digitalInput1 = device.getIO().getDigitalInput(1);
fprintf('Value of digital input channel 1: %d.\n', digitalInput1);
```

**MATLAB:**

```matlab
digitalInput1 = device.IO.getDigitalInput(1);
fprintf('Value of digital input channel 1: %d.\n', digitalInput1);
```

**C++:**

```cpp
bool digitalInput1 = device.getIO().getDigitalInput(1);
std::cout << "Value of digital input channel 1: " << digitalInput1 << std::endl;
```

**LabView:**

![LabView](https://software.zaber.com/dev-portal/motion-library/docs/guides/device_features/device_io/device_io_labview.jpg)

The following example demonstrates reading and printing the values of all analog input channels.

**JavaScript:**

```js
const analogInputs = await device.io.getAllAnalogInputs();
console.log('Values of analog input channels in order:', analogInputs);
```

**Python:**

```py
analog_inputs = device.io.get_all_analog_inputs()
print("Values of analog input channels in order:", str(analog_inputs))
```

**C#:**

```cs
var analogInputs = device.IO.GetAllAnalogInputs();
Console.WriteLine("Values of analog input channels in order: {0}", string.Join(",", analogInputs));
```

**Java:**

```java
double[] analogInputs = device.getIO().getAllAnalogInputs();
System.out.println("Values of analog input channels in order: " + Arrays.toString(analogInputs));
```

**MATLAB (legacy):**

```matlabjava
analogInputs = device.getIO().getAllAnalogInputs();
fprintf('Values of analog input channels in order: ');
fprintf('%d ', analogInputs);
fprintf('\n');
```

**MATLAB:**

```matlab
analogInputs = device.IO.getAllAnalogInputs();
fprintf('Values of analog input channels in order: ');
fprintf('%d ', analogInputs);
fprintf('\n');
```

**C++:**

```cpp
std::vector<double> analogInputs = device.getIO().getAllAnalogInputs();
std::cout << "Values of analog input channels in order: ";
for (const auto ai: analogInputs) {
    std::cout << ai << " ";
}
std::cout << std::endl;
```

**LabView:**

![LabView](https://software.zaber.com/dev-portal/motion-library/docs/guides/device_features/device_io/device_io_labview.jpg)

This example shows how to set analog output channel 1 to 1.5 V.

**JavaScript:**

```js
await device.io.setAnalogOutput(1, 1.5);
```

**Python:**

```py
device.io.set_analog_output(1, 1.5)
```

**C#:**

```cs
device.IO.SetAnalogOutput(1, 1.5);
```

**Java:**

```java
device.getIO().setAnalogOutput(1, 1.5);
```

**MATLAB (legacy):**

```matlabjava
device.getIO().setAnalogOutput(1, 1.5);
```

**MATLAB:**

```matlab
device.IO.setAnalogOutput(1, 1.5);
```

**C++:**

```cpp
device.getIO().setAnalogOutput(1, 1.5);
```

**LabView:**

![LabView](https://software.zaber.com/dev-portal/motion-library/docs/guides/device_features/device_io/device_io_labview.jpg)

This example shows how to set digital output channel 2 to `ON`. Digital output actions can be `ON`, `OFF`, `TOGGLE`, or `KEEP`. Note that some languages will require a specific import for the `DigitalOutputAction` enum.

**JavaScript:**

```js
await device.io.setDigitalOutput(2, DigitalOutputAction.ON);
```

**Python:**

```py
device.io.set_digital_output(2, DigitalOutputAction.ON)
```

**C#:**

```cs
device.IO.SetDigitalOutput(2, DigitalOutputAction.On);
```

**Java:**

```java
device.getIO().setDigitalOutput(2, DigitalOutputAction.ON);
```

**MATLAB (legacy):**

```matlabjava
device.getIO().setDigitalOutput(2, DigitalOutputAction.ON);
```

**MATLAB:**

```matlab
device.IO.setDigitalOutput(2, DigitalOutputAction.On);
```

**C++:**

```cpp
device.getIO().setDigitalOutput(2, DigitalOutputAction::ON);
```

**LabView:**

![LabView](https://software.zaber.com/dev-portal/motion-library/docs/guides/device_features/device_io/device_io_labview.jpg)

This example shows how to set the values of all four digital output channels such that only the first two channels are turned `ON` and the other channels are unchanged with `KEEP`. Note that some languages will require a specific import for the `DigitalOutputAction` enum.

**JavaScript:**

```js
await device.io.setAllDigitalOutputs([DigitalOutputAction.ON, DigitalOutputAction.ON, DigitalOutputAction.KEEP, DigitalOutputAction.KEEP]);
```

**Python:**

```py
device.io.set_all_digital_outputs([DigitalOutputAction.ON, DigitalOutputAction.ON, DigitalOutputAction.KEEP, DigitalOutputAction.KEEP])
```

**C#:**

```cs
device.IO.SetAllDigitalOutputs(new DigitalOutputAction[] { DigitalOutputAction.On, DigitalOutputAction.On, DigitalOutputAction.Keep, DigitalOutputAction.Keep });
```

**Java:**

```java
device.getIO().setAllDigitalOutputs(new DigitalOutputAction[] { DigitalOutputAction.ON, DigitalOutputAction.ON, DigitalOutputAction.KEEP, DigitalOutputAction.KEEP });
```

**MATLAB (legacy):**

```matlabjava
device.getIO().setAllDigitalOutputs([DigitalOutputAction.ON, DigitalOutputAction.ON, DigitalOutputAction.KEEP, DigitalOutputAction.KEEP]);
```

**MATLAB:**

```matlab
device.IO.setAllDigitalOutputs([DigitalOutputAction.On, DigitalOutputAction.On, DigitalOutputAction.Keep, DigitalOutputAction.Keep]);
```

**C++:**

```cpp
device.getIO().setAllDigitalOutputs({ DigitalOutputAction::ON, DigitalOutputAction::ON, DigitalOutputAction::KEEP, DigitalOutputAction::KEEP });
```

**LabView:**

![LabView](https://software.zaber.com/dev-portal/motion-library/docs/guides/device_features/device_io/device_io_labview.jpg)

As of firmware 7.37, Zaber devices support scheduling a digital output action for a set time in the future. For example, here's how to set digital output channel 1 to `ON` immediately, and schedule it to set to `OFF` in 1 second, creating a 1s pulse. Note that some languages will require a specific import for the `DigitalOutputAction` enum.

**JavaScript:**

```js
await device.io.setDigitalOutputSchedule(1, DigitalOutputAction.ON, DigitalOutputAction.OFF, 1, Time.SECONDS);
```

**Python:**

```py
device.io.set_digital_output_schedule(1, DigitalOutputAction.ON, DigitalOutputAction.OFF, 1, Units.TIME_SECONDS)
```

**C#:**

```cs
device.IO.SetDigitalOutputSchedule(1, DigitalOutputAction.On, DigitalOutputAction.Off, 1, Units.Time_Seconds);
```

**Java:**

```java
device.getIO().setDigitalOutputSchedule(1, DigitalOutputAction.ON, DigitalOutputAction.OFF, 1, Units.TIME_SECONDS);
```

**MATLAB (legacy):**

```matlabjava
device.getIO().setDigitalOutputSchedule(1, DigitalOutputAction.ON, DigitalOutputAction.OFF, 1, Units.TIME_SECONDS);
```

**MATLAB:**

```matlab
device.IO.setDigitalOutputSchedule(1, DigitalOutputAction.On, DigitalOutputAction.Off, 1, Units.Time("s"));
```

**C++:**

```cpp
device.getIO().setDigitalOutputSchedule(1, DigitalOutputAction::ON, DigitalOutputAction::OFF, 1, Units::TIME_SECONDS);
```

**LabView:**

![LabView](https://software.zaber.com/dev-portal/motion-library/docs/guides/device_features/device_io/device_io_labview.jpg)

## Reference

For full device I/O reference, please visit:

- [ASCII Protocol Manual (firmware version 7.xx)](https://www.zaber.com/protocol-manual#topic_command_io)
- [ASCII Protocol Manual (firmware version 6.xx)](https://www.zaber.com/wiki/Manuals/ASCII_Protocol_Manual#io_info)

API Reference:

- [`DeviceIO`](https://software.zaber.com/motion-library/api/py/ascii/deviceio.md)
- [`DeviceIOInfo`](https://software.zaber.com/motion-library/api/py/ascii/deviceioinfo.md)
- [`DigitalOutputAction`](https://software.zaber.com/motion-library/api/py/ascii/digitaloutputaction.md)
