libmbus_cmd.3

OpenMODBUS/TCP to RS-232/485 MODBUS RTU gateway librar Zhejiang Univ. Hangzhou, China Dec.2006

.TH "libmbus_cmd" 3 "13 September 2003" "libmbus ver. 0.1.1" "MBUS Library Interface"
.SH "NAME"
mbus_cmd_read_coil_status, mbus_cmd_read_holding_registers, mbus_cmd_force_single_coil,
mbus_cmd_preset_single_register, mbus_cmd_diagnostics, mbus_cmd_force_multiple_coils,
mbus_cmd_preset_multiple_registers, mbus_cmd_report_slave_id \- Set of MODBUS commands supported by MBUS library
.SH "SYNOPSIS"
.ft B
#include <mbus.h>
.br
.sp
int mbus_cmd_read_coil_status
.br
(
.br
	mbus_struct *mbus,
.br
	mbus_ubyte slave_addr,
.br
	mbus_uword coils_addr,
.br
	mbus_uword coils_num,
.br
	mbus_ubyte *coils_data
.br
);
.sp
int mbus_cmd_read_holding_registers
.br
(
.br
	mbus_struct *mbus,
.br
	mbus_ubyte slave_addr,
.br
	mbus_uword start_addr,
.br
	mbus_uword points_num,
.br
	mbus_uword *data
.br
);
.sp
int mbus_cmd_force_single_coil
.br
(
.br
	mbus_struct *mbus,
.br
	mbus_ubyte slave_addr,
.br
	mbus_uword coil_addr,
.br
	mbus_uword data
.br
);
.sp
int mbus_cmd_preset_single_register
.br
(
.br
	mbus_struct *mbus,
.br
	mbus_ubyte slave_addr,
.br
	mbus_uword register_addr,
.br
	mbus_uword preset_data
.br
);
.sp
int mbus_cmd_diagnostics
.br
(
.br
	mbus_struct *mbus,
.br
	mbus_ubyte slave_addr,
.br
	mbus_uword subfunction,
.br
	mbus_uword *data
.br
);
.sp
int mbus_cmd_force_multiple_coils
.br
(
.br
	mbus_struct *mbus,
.br
	mbus_ubyte slave_addr,
.br
	mbus_uword coils_addr,
.br
	mbus_uword coils_num,
.br
	mbus_ubyte *coils_data
.br
);
.sp
int mbus_cmd_preset_multiple_registers
.br
(
.br
	mbus_struct *mbus,
.br
	mbus_ubyte slave_addr,
.br
	mbus_uword start_addr,
.br
	mbus_uword points_num,
.br
	mbus_uword *data
.br
);
.sp
int mbus_cmd_report_slave_id
.br
(
.br
	mbus_struct *mbus,
.br
	mbus_ubyte slave_addr,
.br
	mbus_ubyte *data_count,
.br
	mbus_ubyte *slave_data
.br
);
.ft R
.SH "PARAMETERS"
.TP
.B "mbus_struct *mbus"
Pointer to MBUS structure.
.TP
.BR "mbus_ubyte slave_addr" "	(mbus_cmd_check_response)"
MODBUS device address (1-247).
.TP
.B "mbus_ubyte funct_code"
Function code (1-255).
.TP
.BR "mbus_ubyte slave_addr" "	(mbus_cmd_nodata)"
MODBUS device address (0-247).
.TP
.B "mbus_uword addr"
Data address (0-65535).
.TP
.BR "mbus_uword data" "	(mbus_cmd_addr_wdata)"
Query data (0-65535).
.TP
.B "mbus_ubyte *data"
Pointer to the query data.
.TP
.B "mbus_ubyte data_size"
0 for coils, non-zero for registers.
.TP
.B "mbus_word data_count"
Number of data values.
.TP
.B "mbus_uword coils_addr"
Coils address (0-65535).
.TP
.BR "mbus_uword coils_num" "	(mbus_cmd_read_coil_status)"
Number of coils to read (0-65535).
.TP
.BR "mbus_ubyte *coils_data" "	(mbus_cmd_read_coil_status)"
Pointer to readed data buffer.
.TP
.BR "mbus_uword start_addr" "	(mbus_cmd_read_holding_registers)"
Starting register address (0-65535).
.TP
.BR "mbus_uword points_num" "	(mbus_cmd_read_holding_registers)"
Quantity of registers to read (1-65535).
.TP
.BR "mbus_uword *data" "	(mbus_cmd_read_holding_registers)"
Pointer to readed data buffer.
.TP
.B "mbus_uword coil_addr"
Coil address (0-65535).
.TP
.BR "mbus_uword data" "	(mbus_cmd_force_single_coil)"
Force data.
.TP
.B "mbus_uword register_addr"
Starting register address (0-65535).
.TP
.B "mbus_uword preset_data"
Register preset data (0-65535).
.TP
.B "mbus_uword subfunction"
Subfunction code (0-65535).
.TP
.BR "mbus_uword *data" "	(mbus_cmd_diagnostics)"
Pointer to the query data
(replaced by response data in case of success).
.TP
.BR "mbus_uword coils_num" "	(mbus_cmd_force_multiple_coils)"
Number of coils to force (0-65535).
.TP
.BR "mbus_ubyte *coils_data" "	(mbus_cmd_force_multiple_coils)"
Pointer to coils force data.
.TP
.BR "mbus_uword start_addr" "	(mbus_cmd_preset_multiple_registers)"
Registers starting address (0-65535).
.TP
.BR "mbus_uword points_num" "	(mbus_cmd_preset_multiple_registers)"
Number of registers to preset (0-65535).
.TP
.BR "mbus_uword *data" "	(mbus_cmd_preset_multiple_registers)"
Pointer to registers preset data.
.TP
.B "mbus_ubyte *data_count"
Readed slave ID data count.
.TP
.B "mbus_ubyte *slave_data"
Pointer to readed slave ID data buffer.
.SH "DESCRIPTION"
.SS "mbus_cmd_read_coil_status"
MODBUS command - Function Code 01 (Read Coil Status).
.SS "mbus_cmd_read_holding_registers"
MODBUS command - Function Code 03 (Read Holding Registers).
.SS "mbus_cmd_force_single_coil"
MODBUS command - Function Code 05 (Force Single Coil).
.SS "mbus_cmd_preset_single_register"
MODBUS command - Function Code 06 (Preset Single Register).
.SS "mbus_cmd_diagnostics"
MODBUS command - Function Code 08 (Diagnostics).
.SS "mbus_cmd_force_multiple_coils"
MODBUS command - Function Code 15 (Force Multiple Coils).
.SS "mbus_cmd_preset_multiple_registers"
MODBUS command - Function Code 16 (Preset Multiple Registers).
.SS "mbus_cmd_report_slave_id"
MODBUS command - Function Code 17 (Report Slave ID).
.SH "RETURNS"
1 if exception code returned,
0 if response received successfully and
-1 in case of error.
.SH "SEE ALSO"
libmbus(3)
.SH "AUTHORS"
Victor Antonovich ([e-mail])