<!-- Source: https://docs.captron.com/de/application-notes/CaneoSeries10-allen-bradley-aoi -->

# CANEO series10 + Allen-Bradley — Add-On Instruction Guide

This guide walks through integrating a **CANEO series10** button with an **Allen-Bradley** ControlLogix or CompactLogix controller in **Studio 5000 Logix Designer**. By the end you'll be reading the button's state from ladder logic and writing LED scenes or RGB colors to it — all through a CAPTRON **Add-On Instruction (AOI)** that hides the byte-level plumbing.

Most IO-Link masters on EtherNet/IP hand the controller its process data as one flat `SINT` array covering every port on the block. Some CANEO series10 fields, such as the actuation count, are **larger than one byte**, and some masters also **swap the byte order**. The AOI takes care of both: you point it at the master's raw arrays and tell it where your port starts, and it gives you back two clean, named structures to read and write.

## Prerequisites

Before starting, make sure:

- **Studio 5000 Logix Designer** is installed and you have a project open for your controller. This example uses a **5069-L306ER** CompactLogix on firmware **v38**.
- An **IO-Link master** is configured under **I/O Configuration** and its input and output data are visible as controller tags. This example uses a **MURR IMPACT67 Pro E DIO8 IOL8 M12L 5P** (54631).
- The **CANEO series10** is wired to an IO-Link port on the master (this example uses **port 1**).
- You have downloaded **`CANEOseries10_V34_AOI.zip`** and unzipped it to get the two AOI files (see [Download](#download) at the end of this guide).
- You have the CANEO series10 **process data layout** handy for the meaning of each value: [series10 Process Data](/trms/series10/process-data).

### Choose the LED control mode

The series10 only uses the output process data you send it if the button is set to accept it. This is the IO-Link parameter **LED Control Mode**, which you'll find in the IODD under **LEDs → LED Control Mode**:

<table>
  <thead>
    <tr>
      <th>LED Control Mode</th>
      <th>What the button shows</th>
      <th>AOI to use</th>
    </tr>
  </thead>
  <tbody>
    <tr><td><code>Automatic Scene selection</code></td><td>Scenes are selected by the button's own triggers. The output process data is <b>unused</b>.</td><td>—</td></tr>
    <tr><td><code>Scene controlled by IO-Link Process Data</code></td><td>The LED shows one of the eight scenes configured in the IODD. You pick the scene from the PLC.</td><td><code>AOI_CANEOseries10_Scene_Control_V34</code></td></tr>
    <tr><td><code>Advanced control by IO-Link Process Data</code></td><td>The PLC sets the LED directly: on/off, RGB color, effect, and brightness.</td><td><code>AOI_CANEOseries10_Advanced_Control_v34</code></td></tr>
    <tr><td><code>Classic Two LED Mode</code></td><td>The LED is driven by the input pins. The output process data is <b>unused</b>.</td><td>—</td></tr>
  </tbody>
</table>

Scene control covers most applications. Use Advanced control when eight scenes aren't enough and you want to set the LED color from the PLC. For details on each mode, see [series10 LED Control](/trms/series10/led-control).

> **Pick one AOI per button.** The two AOIs share the same input structure, but their output structures are different and match only their own LED Control Mode. Set the LED Control Mode on the button first, then use the matching AOI.

---

## 1. Import the Add-On Instructions {/* #import-aoi */}

In the **Controller Organizer**, expand **Assets**, then right-click **Add-On Instructions** and choose **Import Add-On Instruction…**.

![Right-click menu on Add-On Instructions with Import Add-On Instruction highlighted](./images/caneo10-ab-aoi-image1.png)

Browse to the unzipped files and import **`CANEOseries10_Scene_Control_V34_AOI.L5X`**, **`CANEOseries10_Advanced_Control_v34_AOI.L5X`**, or both. Confirm the import dialog that follows.

![Import Add-On Instruction dialog showing the CANEO AOI files](./images/caneo10-ab-aoi-image2.png)

After the import, the AOIs appear under **Add-On Instructions**, and their user-defined data types (UDTs) appear under **Data Types → User-Defined**:

- **`CANEOseries10_PDIN`** — the process data coming *from* the button. Used by both AOIs.
- **`CANEOseries10_PDOUT_Scene_Controlled`** — the process data going *to* the button in Scene control mode.
- **`CANEOseries10_PDOUT_Advanced_Control`** — the process data going *to* the button in Advanced control mode.

---

## 2. AOI parameters

Open the AOI definition and switch to the **Parameters** tab to see what the instruction expects. Both AOIs have the same parameters — only the data type of `IOL_PD_OUT` differs.

![Add-On Instruction Definition showing the AOI_CANEOseries10_Advanced_Control_v34 parameters](./images/caneo10-ab-aoi-image3.png)

<table>
  <thead>
    <tr>
      <th>Parameter</th>
      <th>Data type</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr><td><code>IOL_PD_IN</code></td><td><code>CANEOseries10_PDIN</code></td><td>Structure the AOI fills with the CANEO series10 input process data. <b>Read</b> the button's state from here. See <a href="#iol-pd-in">Reading the button</a>.</td></tr>
    <tr><td><code>IOL_PD_OUT</code></td><td><code>CANEOseries10_PDOUT_Scene_Controlled</code> or <code>CANEOseries10_PDOUT_Advanced_Control</code></td><td>Structure you <b>write</b> to. The AOI packs it into the output process data. See <a href="#iol-pd-out-scene">Scene control</a> and <a href="#iol-pd-out-advanced">Advanced control</a>.</td></tr>
    <tr><td><code>IOL_PD_IN_RAW</code></td><td><code>SINT[16]</code></td><td>The raw IO-Link input process data array from the IO-Link master (as defined by the master's EDS file).</td></tr>
    <tr><td><code>IOL_PD_OUT_RAW</code></td><td><code>SINT[16]</code></td><td>The raw IO-Link output process data array from the IO-Link master (as defined by the master's EDS file).</td></tr>
    <tr><td><code>IOL_PD_IN_RAW_START_INDEX</code></td><td><code>DINT</code></td><td>Index of the first input byte of the port the CANEO series10 is connected to. Consult your IO-Link master's manual for the byte layout.</td></tr>
    <tr><td><code>IOL_PD_OUT_RAW_START_INDEX</code></td><td><code>DINT</code></td><td>Index of the first output byte of the port the CANEO series10 is connected to. Consult your IO-Link master's manual for the byte layout.</td></tr>
    <tr><td><code>byteswap</code></td><td><code>BOOL</code></td><td>Set to <code>1</code> if your IO-Link master swaps the byte order of the process data. Default is <code>0</code> (no swap).</td></tr>
  </tbody>
</table>

> **Do I need byte swapping?** IO-Link masters don't all format process data the same way. Some present each 16-bit word with its two bytes swapped. Masters from **Turck**, **IFM**, and **Comtrol** commonly do this. If the LED colors come out mixed up, or values like the actuation count look wrong, set `byteswap` to `1`.

---

## 3. Add the AOI to your routine {/* #add-aoi */}

Open your routine (here **MainProgram → series10**) and add the AOI that matches your LED Control Mode to a rung — you'll find both in the **Toolbox** under **Add-On**. Every operand starts as a question mark.

![AOI_CANEOseries10_Scene_Control_V34 placed on rung 0 with all operands unassigned](./images/caneo10-ab-aoi-image4.png)

Fill in the operands one by one. For the tags that don't exist yet, right-click the question mark and choose **New Tag**:

1. **AOI instance** — create a new tag of the AOI's type (e.g. `AOI_port1_MURR`). Use one instance per button.
2. **`IOL_PD_IN`** — create a new tag of type `CANEOseries10_PDIN` (e.g. `CS10_PDIN_port1`).
3. **`IOL_PD_OUT`** — create a new tag of the matching output type (e.g. `CS10_PDOUT_port1` of type `CANEOseries10_PDOUT_Scene_Controlled`).
4. **`IOL_PD_IN_RAW`** / **`IOL_PD_OUT_RAW`** — select the IO-Link master's input and output data arrays from the **Controller Tags**.
5. **`IOL_PD_IN_RAW_START_INDEX`** / **`IOL_PD_OUT_RAW_START_INDEX`** — enter the index of the first input and output byte of the port the CANEO series10 is connected to. These values are specific to your IO-Link master. If your master (or the master manufacturer's own AOI) already gives you a separate array per port, the start index is most likely `0` — see [Using integer arrays](#int-arrays).
6. **`byteswap`** — `0` or `1`, depending on your master (see above).

### Example: MURR IMPACT67 (54631), port 1

![AOI configured for a MURR 54631 IO-Link master, port 1](./images/caneo10-ab-aoi-image5.png)

<table>
  <thead>
    <tr>
      <th>Operand</th>
      <th>Value</th>
      <th>Why</th>
    </tr>
  </thead>
  <tbody>
    <tr><td>AOI instance</td><td><code>AOI_port1_MURR</code></td><td>Named after the port and the master it serves.</td></tr>
    <tr><td><code>IOL_PD_IN</code></td><td><code>CS10_PDIN_port1</code></td><td>Named after the product (CS10), the type of process data, and the port.</td></tr>
    <tr><td><code>IOL_PD_OUT</code></td><td><code>CS10_PDOUT_port1</code></td><td>Same naming scheme for the output side.</td></tr>
    <tr><td><code>IOL_PD_IN_RAW</code></td><td><code>Murr54631:I1.Data</code></td><td>The MURR block's complete input data array, stored under Controller Tags.</td></tr>
    <tr><td><code>IOL_PD_OUT_RAW</code></td><td><code>Murr54631:O1.Data</code></td><td>The MURR block's complete output data array.</td></tr>
    <tr><td><code>IOL_PD_IN_RAW_START_INDEX</code></td><td><code>50</code></td><td>First input byte of port 1 in the MURR input array.</td></tr>
    <tr><td><code>IOL_PD_OUT_RAW_START_INDEX</code></td><td><code>34</code></td><td>First output byte of port 1 in the MURR output array.</td></tr>
    <tr><td><code>byteswap</code></td><td><code>0</code></td><td>The MURR block does not swap bytes.</td></tr>
  </tbody>
</table>

In this example the entire MURR data array is passed in, and the start indexes tell the AOI where port 1's data begins inside it. To connect a button on another port, add a second AOI instance with its own `PDIN`/`PDOUT` tags and that port's start indexes.

---

## 4. `IOL_PD_IN` — reading the button {/* #iol-pd-in */}

`CANEOseries10_PDIN` is the same for both AOIs. It holds the button's actuation state, its pin states, and its sensor readings.

![CS10_PDIN_port1 expanded showing the process data input members](./images/caneo10-ab-aoi-image6.png)

<table>
  <thead>
    <tr>
      <th>Member</th>
      <th>Data type</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr><td><code>Surronding_Brightness</code></td><td><code>SINT</code></td><td>Ambient brightness measured by the button's light sensor, in percent (<code>0</code>…<code>100</code>).</td></tr>
    <tr><td><code>Actuation_Strength</code></td><td><code>SINT</code></td><td>Damping of the sensor, in percent (<code>0</code>…<code>100</code>).</td></tr>
    <tr><td><code>Actuation_Count</code></td><td><code>INT</code></td><td>Number of actuations since the button was powered on. Resets on restart and after <code>65535</code>.</td></tr>
    <tr><td><code>Actuation_Flag</code></td><td><code>SINT</code></td><td>Sensor actuation state: <code>0</code> = idle, <code>1</code> = actuated.</td></tr>
    <tr><td><code>Pin_5</code></td><td><code>SINT</code></td><td>Input 2 (E2) pin state: <code>4</code> = input off, <code>5</code> = input on, <code>8</code> = pin unused.</td></tr>
    <tr><td><code>Pin_4</code></td><td><code>BOOL</code></td><td>OUT pin state: <code>0</code> = output off, <code>1</code> = output on.</td></tr>
    <tr><td><code>Pin_2</code></td><td><code>SINT</code></td><td>Input 1 (E1) pin state: <code>4</code> = input off, <code>5</code> = input on, <code>8</code> = pin unused.</td></tr>
  </tbody>
</table>

> **`Actuation_Count` above 32767 shows as negative.** The button counts up to `65535`, but `INT` in Logix is signed. Past `32767` the tag rolls over to negative values. If you need the full range, copy it into a `DINT` and add `65536` when it's negative.

For the full input layout, see [series10 Process Data](/trms/series10/process-data).

---

## 5. `IOL_PD_OUT` — Scene control mode {/* #iol-pd-out-scene */}

Use `CANEOseries10_PDOUT_Scene_Controlled` with **`AOI_CANEOseries10_Scene_Control_V34`** when the LED Control Mode is `Scene controlled by IO-Link Process Data`.

![CS10_PDOUT_port1 expanded showing the LED_SCENE member](./images/caneo10-ab-aoi-image7.png)

<table>
  <thead>
    <tr>
      <th>Member</th>
      <th>Data type</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr><td><code>LED_SCENE</code></td><td><code>SINT</code></td><td>Active LED scene, <code>0</code>…<code>7</code>. Write <code>-1</code> (<code>255</code>) to let the button select the scene from its actuation and input pins instead.</td></tr>
  </tbody>
</table>

The scenes themselves — color and effect for each of the eight — are configured in the IODD. See [series10 LED Scenes](/trms/series10/led-scenes).

---

## 6. `IOL_PD_OUT` — Advanced control mode {/* #iol-pd-out-advanced */}

Use `CANEOseries10_PDOUT_Advanced_Control` with **`AOI_CANEOseries10_Advanced_Control_v34`** when the LED Control Mode is `Advanced control by IO-Link Process Data`.

![CS10_PDOUT_port1_ADVANCED expanded showing the Advanced control output members](./images/caneo10-ab-aoi-image8.png)

<table>
  <thead>
    <tr>
      <th>Member</th>
      <th>Data type</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr><td><code>Active_LEDs</code></td><td><code>INT</code></td><td>Turns the LED on or off: <code>1</code> = on, <code>0</code> = off.</td></tr>
    <tr><td><code>LED_Brightness</code></td><td><code>SINT</code></td><td>Brightness of the LED ring in percent (<code>0</code>…<code>100</code>). Write <code>-1</code> (<code>255</code>) for automatic brightness.</td></tr>
    <tr><td><code>LED_Color_R</code></td><td><code>SINT</code></td><td>Red component of the LED color, <code>0</code>…<code>255</code>.</td></tr>
    <tr><td><code>LED_Color_G</code></td><td><code>SINT</code></td><td>Green component of the LED color, <code>0</code>…<code>255</code>.</td></tr>
    <tr><td><code>LED_Color_B</code></td><td><code>SINT</code></td><td>Blue component of the LED color, <code>0</code>…<code>255</code>.</td></tr>
    <tr><td><code>LED_Effect</code></td><td><code>SINT</code></td><td>LED effect: <code>0</code> = <code>Static Ring</code>, <code>1</code> = <code>Flash Ring</code>, <code>2</code> = <code>Pulse Ring</code>.</td></tr>
    <tr><td><code>Effect_Frequency</code></td><td><code>SINT</code></td><td>Frequency of the LED effect in 1/10 Hz, <code>1</code>…<code>60</code> (0.1…6 Hz). <code>0</code> = default frequency.</td></tr>
  </tbody>
</table>

> **Values above 127 are written as negatives.** `SINT` in Logix is signed (`-128`…`127`), but the color and brightness fields take `0`…`255`. To send a value above 127, write it minus 256 — for example `-1` for `255` (full color or automatic brightness) or `-128` for `128`.

---

## 7. Usage example — Scene control {/* #usage-scene */}

The ladder logic below switches LED scenes based on the button's OUT pin.

![Ladder logic switching LED scenes on Pin_4](./images/caneo10-ab-aoi-image9.png)

- **Rung 0** — calls `AOI_CANEOseries10_Scene_Control_V34`. It must be scanned on every cycle, so leave it unconditional.
- **Rung 1** — while the OUT pin is **on** (`XIC CS10_PDIN_port1.Pin_4`), `MOVE 1` into `LED_SCENE` — scene 1 is active.
- **Rung 2** — while the OUT pin is **off** (`XIO CS10_PDIN_port1.Pin_4`), `MOVE 0` into `LED_SCENE` — scene 0 is active.

---

## 8. Usage example — Advanced control {/* #usage-advanced */}

The ladder logic below turns the LED on at full brightness and sets its color from the button's OUT pin.

![Ladder logic setting the LED color on Pin_4](./images/caneo10-ab-aoi-image10.png)

- **Rung 0** — calls the AOI. For Advanced control, this must be `AOI_CANEOseries10_Advanced_Control_v34` with `CS10_PDOUT_port1_ADVANCED` as `IOL_PD_OUT`. Leave it unconditional.
- **Rung 1** — sets `LED_Brightness` to `100` and `Active_LEDs` to `1` (LED on).
- **Rung 2** — while the OUT pin is **on** (`XIC CS10_PDIN_port1.Pin_4`), sets `LED_Color_R` to `-1` (`255`).
- **Rung 3** — while the OUT pin is **off** (`XIO CS10_PDIN_port1.Pin_4`), sets `LED_Color_G` to `-1` (`255`).

> **Clear the other color when you switch.** A `MOVE` only writes while its rung is true, so a color you set stays set until something writes over it. To switch cleanly between red and green, also `MOVE 0` into `LED_Color_G` in rung 2 and into `LED_Color_R` in rung 3. Otherwise both stay at `255` after the first press and the LED shows yellow.

To blink or pulse the LED, write `1` (`Flash Ring`) or `2` (`Pulse Ring`) to `LED_Effect` and a speed to `Effect_Frequency`.

---

## 9. Using integer arrays and an IO-Link master AOI {/* #int-arrays */}

Some IO-Link masters, such as the **IFM AL1322**, import their data as an **`INT` array** instead of a `SINT` array, and some come with their own AOI that pulls one port's data into a separate array. The CANEO series10 AOIs expect `SINT` arrays, so convert with a **`CPS`** instruction on the way in and back on the way out:

1. The master manufacturer's AOI (if any) extracts the port's data into its own array.
2. **`CPS`** copies the input array into a `SINT` array for `IOL_PD_IN_RAW`.
3. The CANEO series10 AOI runs, with both start indexes set to `0` because the arrays already hold only that port's data.
4. **`CPS`** copies the `SINT` array from `IOL_PD_OUT_RAW` back into the master's output array.

Set `byteswap` to `1` for masters that swap bytes, such as IFM. For a full walkthrough with screenshots, see step 7 of the [CANEO series5x + Allen-Bradley guide](/application-notes/CaneoSeries5x-allen-bradley-aoi#ifm-int-arrays). The same steps apply to the series10.

---

## Tested IO-Link masters

The AOIs were created and tested with the following IO-Link masters:

- **MURR** IMPACT67 Pro E DIO8 IOL8 M12L 5P (54631)
- **IFM** AL1322 (byte swap enabled — see [step 9](#int-arrays))
- **SICK** SIG300

Other IO-Link masters on EtherNet/IP should work as long as you set the correct start indexes and `byteswap` value for that master.

---

## Reference

- **CANEO series10 Process Data:** [series10 Process Data](/trms/series10/process-data)
- **CANEO series10 LED Control:** [series10 LED Control](/trms/series10/led-control)
- **CANEO series10 LED Scenes:** [series10 LED Scenes](/trms/series10/led-scenes)

---

## Download: Add-On Instructions {/* #download */}

Download the CAPTRON Add-On Instructions used in this guide. The zip contains both AOIs — `CANEOseries10_Scene_Control_V34_AOI.L5X` and `CANEOseries10_Advanced_Control_v34_AOI.L5X` — and each one includes its data types. Unzip it and import the `.L5X` file you need as described in [step 1](#import-aoi).

<a href="/downloads/CANEOseries10_V34_AOI.zip" target="_blank">CANEOseries10_V34_AOI.zip</a>
