[EthercatDevice_DmpHID_Generic]
Description
Configure the UART frame format for the specified UART port of the EtherCAT slave device.
Derived Class:
| Class Name | Vendor ID | Product Code | UART | Keypad | LCM | MPG |
| EthercatDevice_QECR11HU1S | 0x00000bc3 | 0x0086d404 | O | O | ||
| EthercatDevice_QECR11HU5S | 0x00000bc3 | 0x0086d403 | O | |||
| EthercatDevice_QECR00HU5S | 0x00000bc3 | 0x0086d400 | O | |||
| EthercatDevice_QECR11HU9S | 0x00000bc3 | 0x0086d402 | O | O | O | O |
| EthercatDevice_QECR00HU9S | 0x00000bc3 | 0x0086d401 | O | O | O | O |
Syntax
int uartSetFormat(int dev, uint8_t format);
Parameters
[in] int dev
The specified UART port of the EtherCAT slave device.- 0 for COM1.
- 1 for COM2.
[in] uint8_t format
The UART frame format to be configured. The bit definition of this parameter is as follows:
Data Bits: These bits define the word length of the data being transmitted and received.
| Definition | Value | Description |
| ECAT_UART_BYTESIZE5 | 0x00 | 5 data bits. |
| ECAT_UART_BYTESIZE6 | 0x01 | 6 data bits. |
| ECAT_UART_BYTESIZE7 | 0x02 | 7 data bits. |
| ECAT_UART_BYTESIZE8 | 0x03 | 8 data bits. |
Stop: This bit selects the number of stop bits to be transmitted.
| Definition | Value | Description |
| ECAT_UART_STOPBIT1 | 0x00 | One stop bit. |
| ECAT_UART_STOPBIT2 | 0x04 | Two stop bits (1.5 with 5-bit data). |
Parity: These bits select the way in which parity control is performed.
| Definition | Value | Description |
| ECAT_UART_NOPARITY | 0x00 | No parity bit. |
| ECAT_UART_ODDPARITY | 0x08 | Odd parity. |
| ECAT_UART_EVENPARITY | 0x18 | Even parity. |
| ECAT_UART_MARKPARITY | 0x28 | The parity bit exists and is always 1. |
| ECAT_UART_SPACEPARITY | 0x38 | The parity bit exists and is always 0. |
Return Value
Return an error code. If the returned value is zero, it indicates a successful execution of this function.
Comment
This function must be called after a successful execution of EthercatMaster::begin(). This function is blocking and cannot be called within the Cyclic Callback.
Example
#include "Ethercat.h"
EthercatMaster master;
EthercatDevice_QECR11HU9S slave;
void setup() {
master.begin();
slave.attach(0, master);
slave.uartSetFormat(0, ECAT_UART_BYTESIZE8 + ECAT_UART_NOPARITY + ECAT_UART_STOPBIT1);
}
void loop() {
// ...
}Please see EthercatDevice_DmpHID_Generic Class for more QEC HID slave instructions and API usage.
