VMX-pi C++ HAL Library for Raspberry Pi
VMX-pi Robotics Controller & Vision/Motion Processor
Typedefs | Enumerations | Variables
VMXChannel.h File Reference
#include <stdint.h>

Go to the source code of this file.

Typedefs

typedef uint8_t VMXChannelIndex
 Type representing the 0-based index of a VMX Channel.
 

Enumerations

enum  VMXChannelType {
  INVALID = 0, FlexDIO = 1, AnalogIn = 2, HiCurrDIO = 3,
  CommDIO = 4, CommI2C = 5
}
 Enumeration of VMX Channel types. More...
 
enum  VMXChannelCapability {
  None = 0x00000000, DigitalInput = 0x00000001, DigitalOutput = 0x00000002, PWMGeneratorOutput = 0x00000004,
  PWMGeneratorOutput2 = 0x00000008, PWMCaptureInput = 0x00000010, EncoderAInput = 0x00000020, EncoderBInput = 0x00000040,
  AccumulatorInput = 0x00000080, AnalogTriggerInput = 0x00000100, InterruptInput = 0x00000200, UART_TX = 0x00000400,
  UART_RX = 0x00000800, SPI_CLK = 0x00001000, SPI_MISO = 0x00002000, SPI_MOSI = 0x00004000,
  SPI_CS = 0x00008000, I2C_SDA = 0x00010000, I2C_SCL = 0x00020000
}
 Enumeration of VMX Channel Capabilities. More...
 

Variables

const VMXChannelIndex INVALID_VMX_CHANNEL_INDEX = 255
 Constant representing an invalid VMXChannelIndex.
 

Enumeration Type Documentation

◆ VMXChannelCapability

Enumeration of VMX Channel Capabilities.

Enumerator
DigitalInput 

The VMX Channel can be routed to a DigitalIO resource in input mode.

DigitalOutput 

The VMX Channel can be routed to a DigitalIO resource in output mode.

PWMGeneratorOutput 

The VMX Channel can be routed to a PWM Generator resource's first port.

PWMGeneratorOutput2 

The VMX Channel can be routed to a PWM Generator resource's second port.

PWMCaptureInput 

The VMX Channel can be routed to a PWM Capture resource.

EncoderAInput 

The VMX Channel can be routed to an Encoder resource's A (first) port.

EncoderBInput 

The VMX Channel can be routed to an Encoder resource's B (second) port.

AccumulatorInput 

The VMX Channel can be routed to an Accumulator resource.

AnalogTriggerInput 

The VMX Channel can be routed to an Analog Trigger resource.

InterruptInput 

The VMX Channel can be routed to an Interrupt resource.

UART_TX 

The VMX Channel can be routed to a UART resource's TX port.

UART_RX 

The VMX Channel can be routed to a UART resource's RX port.

SPI_CLK 

The VMX Channel can be routed to a SPI resource's CLK port.

SPI_MISO 

The VMX Channel can be routed to a SPI resource's MISO port.

SPI_MOSI 

The VMX Channel can be routed to a SPI resource's MOSI port.

SPI_CS 

The VMX Channel can be routed to a SPI resource's CS port.

I2C_SDA 

The VMX Channel can be routed to a I2C resource's SDA port.

I2C_SCL 

The VMX Channel can be routed to a I2C resource's SCL port.

◆ VMXChannelType

Enumeration of VMX Channel types.

Enumerator
FlexDIO 

FlexDIO Channels can be configured as input or output, and can also be used with VMX-pi Encoder, PWMGenerator, PWMCapture and Interrupt resources.

AnalogIn 

AnalogIn Channels are dedicated as inputs to AnalogAccumulator and AnalogTrigger resources.

HiCurrDIO 

HiCurrDIO Channels can all be configured as either input or output.

In input mode, they can be used with DigitalInput and Interrupt resources; in output mode, they can be used with DigitalOutput and PWMGenerator resources.

CommDIO 

CommDIO Channels are fixed as either inputs or outputs; they can be used with the UART, SPI or I2C resources; Output CommDIO Channels can be used with PWMGenerator Resources, and input CommDIO Chnnels can be used with DigitalInput or Interrupt resources.