Modbux v0.3.9 Modbux.Tcp.Client View Source
API for Modbus TCP Client.
Link to this section Summary
Functions
Returns a specification to start this module under a supervisor.
Close the tcp port of the Client.
Configure the Client (status
must be :closed
).
In passive mode (active: false), reads the confirmation of the connected Modbux Server.
Connect the Client to a Server.
In passive mode (active: false), flushed the pending messages.
Invoked when the server is started. start_link/3
or start/3
will
block until it returns.
Send a request to Modbux TCP Server.
Starts a Modbus TCP Client process.
Gets the state of the Client.
Stops the Client.
Link to this section Types
client_option()
View Sourceclient_option() :: {:ip, {byte(), byte(), byte(), byte()}} | {:active, boolean()} | {:tcp_port, non_neg_integer()} | {:timeout, non_neg_integer()}
Link to this section Functions
Returns a specification to start this module under a supervisor.
See Supervisor
.
Close the tcp port of the Client.
Configure the Client (status
must be :closed
).
The following options are available:
ip
- is the internet address of the desired Modbux TCP Server.tcp_port
- is the Modbux TCP Server tcp port number .timeout
- is the connection timeout.active
- (true
orfalse
) specifies whether data is received as messages (mailbox) or by callingconfirmation/1
each timerequest/2
is called.
In passive mode (active: false), reads the confirmation of the connected Modbux Server.
Connect the Client to a Server.
In passive mode (active: false), flushed the pending messages.
Invoked when the server is started. start_link/3
or start/3
will
block until it returns.
init_arg
is the argument term (second argument) passed to start_link/3
.
Returning {:ok, state}
will cause start_link/3
to return
{:ok, pid}
and the process to enter its loop.
Returning {:ok, state, timeout}
is similar to {:ok, state}
,
except that it also sets a timeout. See the "Timeouts" section
in the module documentation for more information.
Returning {:ok, state, :hibernate}
is similar to {:ok, state}
except the process is hibernated before entering the loop. See
c:handle_call/3
for more information on hibernation.
Returning {:ok, state, {:continue, continue}}
is similar to
{:ok, state}
except that immediately after entering the loop
the c:handle_continue/2
callback will be invoked with the value
continue
as first argument.
Returning :ignore
will cause start_link/3
to return :ignore
and
the process will exit normally without entering the loop or calling
c:terminate/2
. If used when part of a supervision tree the parent
supervisor will not fail to start nor immediately try to restart the
GenServer
. The remainder of the supervision tree will be started
and so the GenServer
should not be required by other processes.
It can be started later with Supervisor.restart_child/2
as the child
specification is saved in the parent supervisor. The main use cases for
this are:
- The
GenServer
is disabled by configuration but might be enabled later. - An error occurred and it will be handled by a different mechanism than the
Supervisor
. Likely this approach involves callingSupervisor.restart_child/2
after a delay to attempt a restart.
Returning {:stop, reason}
will cause start_link/3
to return
{:error, reason}
and the process to exit with reason reason
without
entering the loop or calling c:terminate/2
.
Callback implementation for GenServer.init/1
.
Send a request to Modbux TCP Server.
cmd
is a 4 elements tuple, as follows:
{:rc, slave, address, count}
readcount
coils.{:ri, slave, address, count}
readcount
inputs.{:rhr, slave, address, count}
readcount
holding registers.{:rir, slave, address, count}
readcount
input registers.{:fc, slave, address, value}
force single coil.{:phr, slave, address, value}
preset single holding register.{:fc, slave, address, values}
force multiple coils.{:phr, slave, address, values}
preset multiple holding registers.
Starts a Modbus TCP Client process.
The following options are available:
ip
- is the internet address of the desired Modbux TCP Server.tcp_port
- is the desired Modbux TCP Server tcp port number.timeout
- is the connection timeout.active
- (true
orfalse
) specifies whether data is received as messages (mailbox) or by callingconfirmation/1
each timerequest/2
is called.The messages (when active mode is true) have the following form:
{:modbus_tcp, cmd, values}
Example
Modbux.Tcp.Client.start_link(ip: {10,77,0,2}, port: 502, timeout: 2000, active: true)
Gets the state of the Client.
Stops the Client.