InterconnectConfig \(C++\)
June 4, 2021 ยท View on GitHub
This page describes the C++ InterconnectConfig API.
RPC reference
This section describes the existing RPCs used in this API.
Service to get and set interface module (interconnect) configuration information, including user expansion
InterconnectConfigClient RPCs
| Function name | Return type | Input type | Description |
|---|---|---|---|
| GetUARTConfiguration | UARTConfiguration | UARTDeviceIdentification | Retrieves user UART configuration |
| SetUARTConfiguration | Empty | UARTConfiguration | Configures user UART |
| GetEthernetConfiguration | EthernetConfiguration | EthernetDeviceIdentification | Retrieves user Ethernet configuration |
| SetEthernetConfiguration | Empty | EthernetConfiguration | Configures user Ethernet port |
| GetGPIOConfiguration | GPIOConfiguration | GPIOIdentification | Retrieves user GPIO configuration |
| SetGPIOConfiguration | Empty | GPIOConfiguration | Configures user GPIO |
| GetGPIOState | GPIOState | GPIOIdentification | Retrieves user GPIO state |
| SetGPIOState | Empty | GPIOState | Configures user GPIO state |
| GetI2CConfiguration | I2CConfiguration | I2CDeviceIdentification | Retrieves user I2C configuration |
| SetI2CConfiguration | Empty | I2CConfiguration | Configures user I2C |
| I2CRead | I2CData | I2CReadParameter | Performs an I2C read request |
| I2CReadRegister | I2CData | I2CReadRegisterParameter | Performs an I2C read register request |
| I2CWrite | Empty | I2CWriteParameter | Performs an I2C write request |
| I2CWriteRegister | Empty | I2CWriteRegisterParameter | Performs an I2C write register request |
Class reference
This section describes the data classes used in this API.
Messages
| Class | Description |
|---|---|
| EthernetConfiguration | Ethernet configuration information |
| EthernetDeviceIdentification | Ethernet device identification |
| GPIOConfiguration | GPIO configuration information |
| GPIOIdentification | GPIO identification |
| GPIOState | GPIO state |
| I2CConfiguration | I2C configuration information |
| I2CData | I2C data |
| I2CDeviceIdentification | I2C device identification |
| I2CReadParameter | I2C read request |
| I2CReadRegisterParameter | I2C read register request |
| I2CWriteParameter | I2C write request |
| I2CWriteRegisterParameter | I2C write register request |
Enumerators
| Enumerator | Description |
|---|---|
| EthernetDevice | Admissible Ethernet device |
| EthernetDuplex | Admissible Ethernet duplex mode |
| EthernetSpeed | Admissible Ethernet speed |
| GPIOIdentifier | Admissible GPIO identifier |
| GPIOMode | Admissible GPIO mode |
| GPIOPull | Admissible GPIO pull mode |
| GPIOValue | Admissible GPIO value |
| I2CDevice | Admissible I2C device |
| I2CDeviceAddressing | I2C device addressing mode |
| I2CMode | I2C mode |
| I2CRegisterAddressSize | I2C register address size |
| SafetyIdentifier | Admissible interface module safeties |
| ServiceVersion | Identifies InterconnectConfig current version |
| UARTPortId | Admissible UART port |