#include "nanomodbus.h"
#include <stdbool.h>
#include <stdint.h>
#include <string.h>

Macros
#define	NMBS_DEBUG_PRINT(...) (void) (0)

Functions
nmbs_error	nmbs_create (nmbs_t nmbs, const nmbs_platform_conf platform_conf)

void	nmbs_set_read_timeout (nmbs_t *nmbs, int32_t timeout_ms)

void	nmbs_set_byte_timeout (nmbs_t *nmbs, int32_t timeout_ms)

void	nmbs_set_destination_rtu_address (nmbs_t *nmbs, uint8_t address)

void	nmbs_set_platform_arg (nmbs_t nmbs, void arg)

uint16_t	nmbs_crc_calc (const uint8_t *data, uint32_t length)

nmbs_error	recv_write_single_coil_res (nmbs_t *nmbs, uint16_t address, uint16_t value_req)

nmbs_error	recv_write_single_register_res (nmbs_t *nmbs, uint16_t address, uint16_t value_req)

nmbs_error	recv_write_multiple_coils_res (nmbs_t *nmbs, uint16_t address, uint16_t quantity)

nmbs_error	recv_write_multiple_registers_res (nmbs_t *nmbs, uint16_t address, uint16_t quantity)

nmbs_error	recv_read_file_record_res (nmbs_t nmbs, uint16_t registers, uint16_t count)

nmbs_error	recv_write_file_record_res (nmbs_t nmbs, uint16_t file_number, uint16_t record_number, const uint16_t registers, uint16_t count)

nmbs_error	recv_read_device_identification_res (nmbs_t nmbs, uint8_t buffers_count, char buffers_out, uint8_t buffers_length, const uint8_t order, uint8_t ids_out, uint8_t next_object_id_out, uint8_t *objects_count_out)

nmbs_error	nmbs_server_create (nmbs_t nmbs, uint8_t address_rtu, const nmbs_platform_conf platform_conf, const nmbs_callbacks *callbacks)

nmbs_error	nmbs_server_poll (nmbs_t *nmbs)

void	nmbs_set_callbacks_arg (nmbs_t nmbs, void arg)

nmbs_error	nmbs_client_create (nmbs_t nmbs, const nmbs_platform_conf platform_conf)

nmbs_error	nmbs_read_coils (nmbs_t *nmbs, uint16_t address, uint16_t quantity, nmbs_bitfield coils_out)

nmbs_error	nmbs_read_discrete_inputs (nmbs_t *nmbs, uint16_t address, uint16_t quantity, nmbs_bitfield inputs_out)

nmbs_error	nmbs_read_holding_registers (nmbs_t nmbs, uint16_t address, uint16_t quantity, uint16_t registers_out)

nmbs_error	nmbs_read_input_registers (nmbs_t nmbs, uint16_t address, uint16_t quantity, uint16_t registers_out)

nmbs_error	nmbs_write_single_coil (nmbs_t *nmbs, uint16_t address, uint16_t value)

nmbs_error	nmbs_write_single_register (nmbs_t *nmbs, uint16_t address, uint16_t value)

nmbs_error	nmbs_write_multiple_coils (nmbs_t *nmbs, uint16_t address, uint16_t quantity, const nmbs_bitfield coils)

nmbs_error	nmbs_write_multiple_registers (nmbs_t nmbs, uint16_t address, uint16_t quantity, const uint16_t registers)

nmbs_error	nmbs_read_file_record (nmbs_t nmbs, uint16_t file_number, uint16_t record_number, uint16_t registers, uint16_t count)

nmbs_error	nmbs_write_file_record (nmbs_t nmbs, uint16_t file_number, uint16_t record_number, const uint16_t registers, uint16_t count)

nmbs_error	nmbs_read_write_registers (nmbs_t nmbs, uint16_t read_address, uint16_t read_quantity, uint16_t registers_out, uint16_t write_address, uint16_t write_quantity, const uint16_t *registers)

nmbs_error	nmbs_read_device_identification_basic (nmbs_t nmbs, char vendor_name, char product_code, char major_minor_revision, uint8_t buffers_length)

nmbs_error	nmbs_read_device_identification_regular (nmbs_t nmbs, char vendor_url, char product_name, char model_name, char *user_application_name, uint8_t buffers_length)

nmbs_error	nmbs_read_device_identification_extended (nmbs_t nmbs, uint8_t object_id_start, uint8_t ids, char *buffers, uint8_t ids_length, uint8_t buffer_length, uint8_t objects_count_out)

nmbs_error	nmbs_read_device_identification (nmbs_t nmbs, uint8_t object_id, char buffer, uint8_t buffer_length)

nmbs_error	nmbs_send_raw_pdu (nmbs_t nmbs, uint8_t fc, const uint8_t data, uint16_t data_len)

nmbs_error	nmbs_receive_raw_pdu_response (nmbs_t nmbs, uint8_t data_out, uint8_t data_out_len)

const char *	nmbs_strerror (nmbs_error error)

Macro Definition Documentation

◆ NMBS_DEBUG_PRINT

#define NMBS_DEBUG_PRINT ( ... ) (void) (0)

Definition at line 37 of file nanomodbus.c.

Function Documentation

◆ nmbs_client_create()

nmbs_error nmbs_client_create	(	nmbs_t *	nmbs,
		const nmbs_platform_conf *	platform_conf
	)

Create a new Modbus client.

Parameters

nmbs	pointer to the nmbs_t instance where the client will be created.
platform_conf	nmbs_platform_conf struct with platform configuration. It may be discarded after calling this method.

Returns: NMBS_ERROR_NONE if successful, NMBS_ERROR_INVALID_ARGUMENT otherwise.

Definition at line 1901 of file nanomodbus.c.

◆ nmbs_crc_calc()

uint16_t nmbs_crc_calc	(	const uint8_t *	data,
		uint32_t	length
	)

Calculate the Modbus CRC of some data.

Parameters

data	Data
length	Length of the data

Definition at line 216 of file nanomodbus.c.

◆ nmbs_create()

nmbs_error nmbs_create	(	nmbs_t *	nmbs,
		const nmbs_platform_conf *	platform_conf
	)

Definition at line 172 of file nanomodbus.c.

◆ nmbs_read_coils()

nmbs_error nmbs_read_coils	(	nmbs_t *	nmbs,
		uint16_t	address,
		uint16_t	quantity,
		nmbs_bitfield	coils_out
	)

Send a FC 01 (0x01) Read Coils request

Parameters

nmbs	pointer to the nmbs_t instance
address	starting address
quantity	quantity of coils
coils_out	nmbs_bitfield where the coils will be stored

Returns: NMBS_ERROR_NONE if successful, other errors otherwise.

Definition at line 1929 of file nanomodbus.c.

◆ nmbs_read_device_identification()

nmbs_error nmbs_read_device_identification	(	nmbs_t *	nmbs,
		uint8_t	object_id,
		char *	buffer,
		uint8_t	buffer_length
	)

Send a FC 43 / 14 (0x2B / 0x0E) Read Device Identification to retrieve a single Object Id value (Read Device ID code 4)

Parameters

nmbs	pointer to the nmbs_t instance
object_id	requested Object Id
buffer	char array where the resulting value will be stored
buffer_length	length of the char array

Returns: NMBS_ERROR_NONE if successful, other errors otherwise.

Definition at line 2298 of file nanomodbus.c.

◆ nmbs_read_device_identification_basic()

nmbs_error nmbs_read_device_identification_basic	(	nmbs_t *	nmbs,
		char *	vendor_name,
		char *	product_code,
		char *	major_minor_revision,
		uint8_t	buffers_length
	)

Send a FC 43 / 14 (0x2B / 0x0E) Read Device Identification to read all Basic Object Id values (Read Device ID code 1)

Parameters

nmbs	pointer to the nmbs_t instance
vendor_name	char array where the read VendorName value will be stored
product_code	char array where the read ProductCode value will be stored
major_minor_revision	char array where the read MajorMinorRevision value will be stored
buffers_length	length of every char array

Returns: NMBS_ERROR_NONE if successful, other errors otherwise.

Definition at line 2190 of file nanomodbus.c.

◆ nmbs_read_device_identification_extended()

nmbs_error nmbs_read_device_identification_extended	(	nmbs_t *	nmbs,
		uint8_t	object_id_start,
		uint8_t *	ids,
		char **	buffers,
		uint8_t	ids_length,
		uint8_t	buffer_length,
		uint8_t *	objects_count_out
	)

Send a FC 43 / 14 (0x2B / 0x0E) Read Device Identification to read all Extended Object Id values (Read Device ID code 3)

Parameters

nmbs	pointer to the nmbs_t instance
object_id_start	Object Id to start reading from
ids	array where the read Object Ids will be stored
buffers	array of char arrays where the read values will be stored
ids_length	length of the ids array and buffers array
buffer_length	length of each char array
objects_count_out	retrieved Object Ids count

Returns: NMBS_ERROR_NONE if successful, NMBS_INVALID_ARGUMENT if buffers_count is less than retrieved Object Ids count, other errors otherwise.

Definition at line 2262 of file nanomodbus.c.

◆ nmbs_read_device_identification_regular()

nmbs_error nmbs_read_device_identification_regular	(	nmbs_t *	nmbs,
		char *	vendor_url,
		char *	product_name,
		char *	model_name,
		char *	user_application_name,
		uint8_t	buffers_length
	)

Send a FC 43 / 14 (0x2B / 0x0E) Read Device Identification to read all Regular Object Id values (Read Device ID code 2)

Parameters

nmbs	pointer to the nmbs_t instance
vendor_url	char array where the read VendorUrl value will be stored
product_name	char array where the read ProductName value will be stored
model_name	char array where the read ModelName value will be stored
user_application_name	char array where the read UserApplicationName value will be stored
buffers_length	length of every char array

Returns: NMBS_ERROR_NONE if successful, other errors otherwise.

Definition at line 2226 of file nanomodbus.c.

◆ nmbs_read_discrete_inputs()

nmbs_error nmbs_read_discrete_inputs	(	nmbs_t *	nmbs,
		uint16_t	address,
		uint16_t	quantity,
		nmbs_bitfield	inputs_out
	)

Send a FC 02 (0x02) Read Discrete Inputs request

Parameters

nmbs	pointer to the nmbs_t instance
address	starting address
quantity	quantity of inputs
inputs_out	nmbs_bitfield where the discrete inputs will be stored

Returns: NMBS_ERROR_NONE if successful, other errors otherwise.

Definition at line 1934 of file nanomodbus.c.

◆ nmbs_read_file_record()

nmbs_error nmbs_read_file_record	(	nmbs_t *	nmbs,
		uint16_t	file_number,
		uint16_t	record_number,
		uint16_t *	registers,
		uint16_t	count
	)

Send a FC 20 (0x14) Read File Record

Parameters

nmbs	pointer to the nmbs_t instance
file_number	file number (1 to 65535)
record_number	record number from file (0000 to 9999)
registers	array of registers to read
count	count of registers

Returns: NMBS_ERROR_NONE if successful, other errors otherwise.

Definition at line 2078 of file nanomodbus.c.

◆ nmbs_read_holding_registers()

nmbs_error nmbs_read_holding_registers	(	nmbs_t *	nmbs,
		uint16_t	address,
		uint16_t	quantity,
		uint16_t *	registers_out
	)

Send a FC 03 (0x03) Read Holding Registers request

Parameters

nmbs	pointer to the nmbs_t instance
address	starting address
quantity	quantity of registers
registers_out	array where the registers will be stored

Returns: NMBS_ERROR_NONE if successful, other errors otherwise.

Definition at line 1961 of file nanomodbus.c.

◆ nmbs_read_input_registers()

nmbs_error nmbs_read_input_registers	(	nmbs_t *	nmbs,
		uint16_t	address,
		uint16_t	quantity,
		uint16_t *	registers_out
	)

Send a FC 04 (0x04) Read Input Registers request

Parameters

nmbs	pointer to the nmbs_t instance
address	starting address
quantity	quantity of registers
registers_out	array where the registers will be stored

Returns: NMBS_ERROR_NONE if successful, other errors otherwise.

Definition at line 1966 of file nanomodbus.c.

◆ nmbs_read_write_registers()

nmbs_error nmbs_read_write_registers	(	nmbs_t *	nmbs,
		uint16_t	read_address,
		uint16_t	read_quantity,
		uint16_t *	registers_out,
		uint16_t	write_address,
		uint16_t	write_quantity,
		const uint16_t *	registers
	)

Send a FC 23 (0x17) Read Write Multiple registers

Parameters

nmbs	pointer to the nmbs_t instance
read_address	starting read address
read_quantity	quantity of registers to read
registers_out	array where the read registers will be stored
write_address	starting write address
write_quantity	quantity of registers to write
registers	array of registers values to write

Returns: NMBS_ERROR_NONE if successful, other errors otherwise.

Definition at line 2143 of file nanomodbus.c.

◆ nmbs_receive_raw_pdu_response()

nmbs_error nmbs_receive_raw_pdu_response	(	nmbs_t *	nmbs,
		uint8_t *	data_out,
		uint8_t	data_out_len
	)

Receive a raw response Modbus PDU.

Parameters

nmbs	pointer to the nmbs_t instance
data_out	response data. It's up to the caller to convert this data to host byte order. Can be NULL.
data_out_len	number of bytes to receive

Returns: NMBS_ERROR_NONE if successful, other errors otherwise.

Definition at line 2331 of file nanomodbus.c.

◆ nmbs_send_raw_pdu()

nmbs_error nmbs_send_raw_pdu	(	nmbs_t *	nmbs,
		uint8_t	fc,
		const uint8_t *	data,
		uint16_t	data_len
	)

Send a raw Modbus PDU. CRC on RTU will be calculated and sent by this function.

Parameters

nmbs	pointer to the nmbs_t instance
fc	request function code
data	request data. It's up to the caller to convert this data to network byte order
data_len	length of the data parameter

Returns: NMBS_ERROR_NONE if successful, other errors otherwise.

Definition at line 2317 of file nanomodbus.c.

◆ nmbs_server_create()

nmbs_error nmbs_server_create	(	nmbs_t *	nmbs,
		uint8_t	address_rtu,
		const nmbs_platform_conf *	platform_conf,
		const nmbs_callbacks *	callbacks
	)

Create a new Modbus server.

Parameters

nmbs	pointer to the nmbs_t instance where the client will be created.
address_rtu	RTU address of this server. Can be 0 if transport is not RTU.
platform_conf	nmbs_platform_conf struct with platform configuration. It may be discarded after calling this method.
callbacks	nmbs_callbacks struct with server request callbacks. It may be discarded after calling this method.

Returns: NMBS_ERROR_NONE if successful, NMBS_ERROR_INVALID_ARGUMENT otherwise.

Definition at line 1842 of file nanomodbus.c.

◆ nmbs_server_poll()

nmbs_error nmbs_server_poll ( nmbs_t * nmbs )

Handle incoming requests to the server. This function should be called in a loop in order to serve any incoming request. Its maximum duration, in case of no received request, is the value set with nmbs_set_read_timeout() (unless set to < 0).

Parameters

nmbs	pointer to the nmbs_t instance

Returns: NMBS_ERROR_NONE if successful, other errors otherwise.

Definition at line 1858 of file nanomodbus.c.

◆ nmbs_set_byte_timeout()

void nmbs_set_byte_timeout	(	nmbs_t *	nmbs,
		int32_t	timeout_ms
	)

Set the timeout between the reception/transmission of two consecutive bytes.

Parameters

nmbs	pointer to the nmbs_t instance
timeout_ms	timeout in milliseconds. If < 0, the timeout is disabled.

Definition at line 201 of file nanomodbus.c.

◆ nmbs_set_callbacks_arg()

void nmbs_set_callbacks_arg	(	nmbs_t *	nmbs,
		void *	arg
	)

Set the pointer to user data argument passed to server request callbacks.

Parameters

nmbs	pointer to the nmbs_t instance
arg	user data argument

Definition at line 1894 of file nanomodbus.c.

◆ nmbs_set_destination_rtu_address()

void nmbs_set_destination_rtu_address	(	nmbs_t *	nmbs,
		uint8_t	address
	)

Set the recipient server address of the next request on RTU transport.

Parameters

nmbs	pointer to the nmbs_t instance
address	server address

Definition at line 206 of file nanomodbus.c.

◆ nmbs_set_platform_arg()

void nmbs_set_platform_arg	(	nmbs_t *	nmbs,
		void *	arg
	)

Set the pointer to user data argument passed to platform functions.

Parameters

nmbs	pointer to the nmbs_t instance
arg	user data argument

Definition at line 211 of file nanomodbus.c.

◆ nmbs_set_read_timeout()

void nmbs_set_read_timeout	(	nmbs_t *	nmbs,
		int32_t	timeout_ms
	)

Set the request/response timeout. If the target instance is a server, sets the timeout of the nmbs_server_poll() function. If the target instance is a client, sets the response timeout after sending a request. In case of timeout, the called method will return NMBS_ERROR_TIMEOUT.

Parameters

nmbs	pointer to the nmbs_t instance
timeout_ms	timeout in milliseconds. If < 0, the timeout is disabled.

Definition at line 196 of file nanomodbus.c.

◆ nmbs_strerror()

const char * nmbs_strerror ( nmbs_error error )

Convert a nmbs_error to string

Parameters

error error to be converted

Returns: string representation of the error

Definition at line 2359 of file nanomodbus.c.

◆ nmbs_write_file_record()

nmbs_error nmbs_write_file_record	(	nmbs_t *	nmbs,
		uint16_t	file_number,
		uint16_t	record_number,
		const uint16_t *	registers,
		uint16_t	count
	)

Send a FC 21 (0x15) Write File Record

Parameters

nmbs	pointer to the nmbs_t instance
file_number	file number (1 to 65535)
record_number	record number from file (0000 to 9999)
registers	array of registers to write
count	count of registers

Returns: NMBS_ERROR_NONE if successful, other errors otherwise.

Definition at line 2108 of file nanomodbus.c.

◆ nmbs_write_multiple_coils()

nmbs_error nmbs_write_multiple_coils	(	nmbs_t *	nmbs,
		uint16_t	address,
		uint16_t	quantity,
		const nmbs_bitfield	coils
	)

Send a FC 15 (0x0F) Write Multiple Coils

Parameters

nmbs	pointer to the nmbs_t instance
address	starting address
quantity	quantity of coils
coils	bitfield of coils values

Returns: NMBS_ERROR_NONE if successful, other errors otherwise.

Definition at line 2010 of file nanomodbus.c.

◆ nmbs_write_multiple_registers()

nmbs_error nmbs_write_multiple_registers	(	nmbs_t *	nmbs,
		uint16_t	address,
		uint16_t	quantity,
		const uint16_t *	registers
	)

Send a FC 16 (0x10) Write Multiple Registers

Parameters

nmbs	pointer to the nmbs_t instance
address	starting address
quantity	quantity of registers
registers	array of registers values

Returns: NMBS_ERROR_NONE if successful, other errors otherwise.

Definition at line 2044 of file nanomodbus.c.

◆ nmbs_write_single_coil()

nmbs_error nmbs_write_single_coil	(	nmbs_t *	nmbs,
		uint16_t	address,
		uint16_t	value
	)

Send a FC 05 (0x05) Write Single Coil request

Parameters

nmbs	pointer to the nmbs_t instance
address	coil address
value	coil value

Returns: NMBS_ERROR_NONE if successful, other errors otherwise.

Definition at line 1970 of file nanomodbus.c.

◆ nmbs_write_single_register()

nmbs_error nmbs_write_single_register	(	nmbs_t *	nmbs,
		uint16_t	address,
		uint16_t	value
	)

Send a FC 06 (0x06) Write Single Register request

Parameters

nmbs	pointer to the nmbs_t instance
address	register address
value	register value

Returns: NMBS_ERROR_NONE if successful, other errors otherwise.

Definition at line 1990 of file nanomodbus.c.

◆ recv_read_device_identification_res()

nmbs_error recv_read_device_identification_res	(	nmbs_t *	nmbs,
		uint8_t	buffers_count,
		char **	buffers_out,
		uint8_t	buffers_length,
		const uint8_t *	order,
		uint8_t *	ids_out,
		uint8_t *	next_object_id_out,
		uint8_t *	objects_count_out
	)

Definition at line 773 of file nanomodbus.c.

◆ recv_read_file_record_res()

nmbs_error recv_read_file_record_res	(	nmbs_t *	nmbs,
		uint16_t *	registers,
		uint16_t	count
	)

Definition at line 680 of file nanomodbus.c.

◆ recv_write_file_record_res()

nmbs_error recv_write_file_record_res	(	nmbs_t *	nmbs,
		uint16_t	file_number,
		uint16_t	record_number,
		const uint16_t *	registers,
		uint16_t	count
	)

Definition at line 721 of file nanomodbus.c.

◆ recv_write_multiple_coils_res()

nmbs_error recv_write_multiple_coils_res	(	nmbs_t *	nmbs,
		uint16_t	address,
		uint16_t	quantity
	)

Definition at line 626 of file nanomodbus.c.

◆ recv_write_multiple_registers_res()

nmbs_error recv_write_multiple_registers_res	(	nmbs_t *	nmbs,
		uint16_t	address,
		uint16_t	quantity
	)

Definition at line 653 of file nanomodbus.c.

◆ recv_write_single_coil_res()

nmbs_error recv_write_single_coil_res	(	nmbs_t *	nmbs,
		uint16_t	address,
		uint16_t	value_req
	)

Definition at line 571 of file nanomodbus.c.

◆ recv_write_single_register_res()

nmbs_error recv_write_single_register_res	(	nmbs_t *	nmbs,
		uint16_t	address,
		uint16_t	value_req
	)

Definition at line 599 of file nanomodbus.c.

Macros

Functions

Macro Definition Documentation

◆ NMBS_DEBUG_PRINT

Function Documentation

◆ nmbs_client_create()

◆ nmbs_crc_calc()

◆ nmbs_create()

◆ nmbs_read_coils()

◆ nmbs_read_device_identification()

◆ nmbs_read_device_identification_basic()

◆ nmbs_read_device_identification_extended()

◆ nmbs_read_device_identification_regular()

◆ nmbs_read_discrete_inputs()

◆ nmbs_read_file_record()

◆ nmbs_read_holding_registers()

◆ nmbs_read_input_registers()

◆ nmbs_read_write_registers()

◆ nmbs_receive_raw_pdu_response()

◆ nmbs_send_raw_pdu()

◆ nmbs_server_create()

◆ nmbs_server_poll()

◆ nmbs_set_byte_timeout()

◆ nmbs_set_callbacks_arg()

◆ nmbs_set_destination_rtu_address()

◆ nmbs_set_platform_arg()

◆ nmbs_set_read_timeout()

◆ nmbs_strerror()

◆ nmbs_write_file_record()

◆ nmbs_write_multiple_coils()

◆ nmbs_write_multiple_registers()

◆ nmbs_write_single_coil()

◆ nmbs_write_single_register()

◆ recv_read_device_identification_res()

◆ recv_read_file_record_res()

◆ recv_write_file_record_res()

◆ recv_write_multiple_coils_res()

◆ recv_write_multiple_registers_res()

◆ recv_write_single_coil_res()

◆ recv_write_single_register_res()