@tetherto/svc-facs-modbus
v0.1.1
Published
svc facility for modbus client
Downloads
6,988
Readme
svc-facs-modbus
This facility implements a simple promise based modbus client. It does not use config file or take any opts.
API
fac.getClient
Initiates a modbus client instance for specific server.
Params:
opts.protocol<string>- protocol to use, currently onlytcpis supportedopts.address<string>- host to connect toopts.port<number>- port to connect toopts.unitId<number>- unit id to use
Result:
ModbusClient- modbus client instance
Example:
const client = fac.getClient({
protocol: PROTOCOL.TCP,
address: '127.0.0.1',
port: 502,
unitId: 0
})ModbusClient.read
Reads data from modbus server.
Params:
functionCode<number>- modbus function codeaddress<number>- address to read fromlength<number>- length of data to read (default: 1)
Result:
Promise<Buffer>- promise that resolves to buffer with data
Example:
const data = await client.read(3, 0, 2)ModbusClient.write
Writes data to modbus server.
Params:
functionCode<number>- modbus function codeaddress<number>- address to write todata<Buffer>- data to write
Result:
Promise<Buffer>- promise that resolves to buffer with data
Example:
const data = await client.write(16, 0, Buffer.from([0x01, 0x02]))