diff options
Diffstat (limited to 'examples/stm32/main.c')
| -rw-r--r-- | examples/stm32/main.c | 24 |
1 files changed, 14 insertions, 10 deletions
diff --git a/examples/stm32/main.c b/examples/stm32/main.c index 958e4d7..57ba4e8 100644 --- a/examples/stm32/main.c +++ b/examples/stm32/main.c @@ -1,6 +1,6 @@ #include <modbus.h> -/* +/** * Note that this example is not self-contained. User will need to handle UART * device initialization and relevant HAL/LL library includes. These steps are * skipped in this example to ensure simplicity - illustrated here is the @@ -9,7 +9,7 @@ * */ -/* +/** * If using CubeMX, the HAL library files will be automatically placed in the * correct location. The examples were tested with the Makefile option in * CubeMX. @@ -23,9 +23,11 @@ */ -/* Function initialization for the STM32 HAL Library */ -/* - * Since this library was orignally written to work with the STM32 HAL/LL API, +/** + * + * Function initialization for the STM32 HAL Library + * + * \brief Since this library was orignally written to work with the STM32 HAL/LL API, * the UART functions match perfectly and can be directly mapped to the Modbus * library functions. */ @@ -36,18 +38,20 @@ MB_StatusTypeDef (*MB_UART_Rx)(void*, uint16_t*, uint8_t*, uint8_t*) = int main() { - /* Single modbus device node */ - modbus_slave_device modbus_dev_single; + + modbus_slave_device modbus_dev_single; /*< Single modbus device node */ + /* Multiple modbus device nodes.. after all, what is the point of using * Modbus in a single point-to-point connection? */ /* Not illustrated beyond the definition, but should be clear enough */ modbus_slave_device modbus_dev_multiple[10]; - - /* Set the slave ID to 1 */ - modbus_dev_single.slave_id = 1; + + modbus_dev_single.slave_id = 1; /*< Set the slave ID to 1 */ + /* Attach the UART device on the STM32 to this node */ /* Note that initialization of UART1 is not included in this example */ modbus_dev_single.modbus_uart = &huart1; + /* Continuously read the 30001 input register */ uint16_t register = 30001; |