Mathematica - RS485 Bricklet

This is the description of the Mathematica API bindings for the RS485 Bricklet. General information and technical specifications for the RS485 Bricklet are summarized in its hardware description.

An installation guide for the Mathematica API bindings is part of their general description.

Examples

The example code below is Public Domain (CC0 1.0).

Loopback

Download (ExampleLoopback.nb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

(*For this example connect the RX+/- pins to TX+/- pins on the same Bricklet*)
(*and configure the DIP switch on the Bricklet to full-duplex mode*)

host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your RS485 Bricklet*)

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
rs485=NETNew["Tinkerforge.BrickletRS485",uid,ipcon]
ipcon@Connect[host,port]

(*Enable full-duplex mode*)
rs485@SetRS485Configuration[115200,BrickletRS485`PARITYUNONE,BrickletRS485`STOPBITSU1,
                            BrickletRS485`WORDLENGTHU8,BrickletRS485`DUPLEXUFULL]

(*Callback function for read callback*)
ReadCB[sender_,message_]:=
 Print["Message: "<>FromCharacterCode[message]]
AddEventHandler[rs485@ReadCallback,ReadCB]

(*Enable read callback*)
rs485@EnableReadCallback[]

(*Write "test" string*)
(*FIXME: This call crashes Mono with a SIGSEGV, no clue why*)
rs485@Write[ToCharacterCode["test"]]

Input["Click OK to exit"]

(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[rs485]
ReleaseNETObject[ipcon]

Modbus Master

Download (ExampleModbusMaster.nb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your RS485 Bricklet*)

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
rs485=NETNew["Tinkerforge.BrickletRS485",uid,ipcon]
ipcon@Connect[host,port]

(*Set operating mode to Modbus RTU master*)
rs485@SetMode[BrickletRS485`MODEUMODBUSUMASTERURTU]

(*Modbus specific configuration:*)
(*- slave address = 1 (unused in master mode)*)
(*- master request timeout = 1000ms*)
rs485@SetModbusConfiguration[1,1000]

expectedRequestID=0

(*Callback function for Modbus master write single register response callback*)
ModbusMasterWriteSingleRegisterResponseCB[sender_,requestID_,exceptionCode_]:=
 Module[{},
  Print["Request ID: "<>ToString[requestID]];
  Print["Exception Code: "<>ToString[exceptionCode]];
  If[requestID!=expectedRequestID,Print["Error: Unexpected request ID"]]
 ]

AddEventHandler[rs485@ModbusMasterWriteSingleRegisterResponseCallback,ModbusMasterWriteSingleRegisterResponseCB]

(*Write 65535 to register 42 of slave 17*)
expectedRequestID=rs485@ModbusMasterWriteSingleRegister[17,42,65535]

Input["Click OK to exit"]

(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[rs485]
ReleaseNETObject[ipcon]

Modbus Slave

Download (ExampleModbusSlave.nb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your RS485 Bricklet*)

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
rs485=NETNew["Tinkerforge.BrickletRS485",uid,ipcon]
ipcon@Connect[host,port]

(*Set operating mode to Modbus RTU slave*)
rs485@SetMode[BrickletRS485`MODEUMODBUSUSLAVEURTU]

(*Modbus specific configuration:*)
(*- slave address = 17*)
(*- master request timeout = 0ms (unused in slave mode)*)
rs485@SetModbusConfiguration[17,0]

(*Callback function for Modbus slave write single register request callback*)
ModbusSlaveWriteSingleRegisterRequestCB[sender_,requestID_,registerAddress_,
                                        registerValue_]:=
 Module[{},
  Print["Request ID: "<>ToString[requestID]];
  Print["Register Address: "<>ToString[registerAddress]];
  Print["Register Value: "<>ToString[registerValue]];
  
  If[registerAddress!=42,
   Print["Error: Invalid register address"];
   sender@ModbusSlaveReportException[requestID,BrickletRS485`EXCEPTIONUCODEUILLEGALUDATAUADDRESS],
   sender@ModbusSlaveAnswerWriteSingleRegisterRequest[requestID]
  ]
 ]

AddEventHandler[rs485@ModbusSlaveWriteSingleRegisterRequestCallback,ModbusSlaveWriteSingleRegisterRequestCB]

Input["Click OK to exit"]

(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[rs485]
ReleaseNETObject[ipcon]

API

Generally, every method of the Mathematica bindings that returns a value can throw a Tinkerforge.TimeoutException. This exception gets thrown if the device did not respond. If a cable based connection is used, it is unlikely that this exception gets thrown (assuming nobody plugs the device out). However, if a wireless connection is used, timeouts will occur if the distance to the device gets too big.

Since .NET/Link does not support multiple return values directly, we use the out keyword to return multiple values from a method. For further information about the out keyword in .NET/Link see the corresponding Mathematica .NET/Link documentation.

The namespace for all Brick/Bricklet bindings and the IPConnection is Tinkerforge.*.

Basic Functions

BrickletRS485[uid, ipcon] → rs485
Parameters:
  • uid -- String
  • ipcon -- NETObject[IPConnection]
Returns:
  • rs485 -- NETObject[BrickletRS485]

Creates an object with the unique device ID uid:

rs485=NETNew["Tinkerforge.BrickletRS485","YOUR_DEVICE_UID",ipcon]

This object can then be used after the IP Connection is connected (see examples above).

The .NET runtime has built-in garbage collection that frees objects that are no longer in use by a program. But because Mathematica can not automatically tell when a Mathematica "program" doesn't use a .NET object anymore, this has to be done by the program. For this the ReleaseNETObject[] function is used in the examples.

For further information about object management in .NET/Link see the corresponding Mathematica .NET/Link documentation.

BrickletRS485@Write[{message1, message2, ...}] → messageWritten
Parameters:
  • messagei -- Integer
Returns:
  • messageWritten -- Integer

Writes characters to the RS485 interface. The characters can be binary data, ASCII or similar is not necessary.

The return value is the number of characters that were written.

See SetRS485Configuration[] for configuration possibilities regarding baudrate, parity and so on.

BrickletRS485@Read[length] → {message1, message2, ...}
Parameters:
  • length -- Integer
Returns:
  • messagei -- Integer

Returns up to length characters from receive buffer.

Instead of polling with this function, you can also use callbacks. But note that this function will return available data only when the read callback is disabled. See EnableReadCallback[] and ReadCallback callback.

BrickletRS485@SetRS485Configuration[baudrate, parity, stopbits, wordlength, duplex] → Null
Parameters:
  • baudrate -- Integer
  • parity -- Integer
  • stopbits -- Integer
  • wordlength -- Integer
  • duplex -- Integer

Sets the configuration for the RS485 communication. Available options:

  • Baudrate between 100 and 2000000 baud.
  • Parity of none, odd or even.
  • Stopbits can be 1 or 2.
  • Word length of 5 to 8.
  • Half- or Full-Duplex.

The default is: 115200 baud, parity none, 1 stop bit, word length 8, half duplex.

The following constants are available for this function:

  • BrickletRS485`PARITYUNONE = 0
  • BrickletRS485`PARITYUODD = 1
  • BrickletRS485`PARITYUEVEN = 2
  • BrickletRS485`STOPBITSU1 = 1
  • BrickletRS485`STOPBITSU2 = 2
  • BrickletRS485`WORDLENGTHU5 = 5
  • BrickletRS485`WORDLENGTHU6 = 6
  • BrickletRS485`WORDLENGTHU7 = 7
  • BrickletRS485`WORDLENGTHU8 = 8
  • BrickletRS485`DUPLEXUHALF = 0
  • BrickletRS485`DUPLEXUFULL = 1
BrickletRS485@GetRS485Configuration[out baudrate, out parity, out stopbits, out wordlength, out duplex] → Null
Parameters:
  • baudrate -- Integer
  • parity -- Integer
  • stopbits -- Integer
  • wordlength -- Integer
  • duplex -- Integer

Returns the configuration as set by SetRS485Configuration[].

The following constants are available for this function:

  • BrickletRS485`PARITYUNONE = 0
  • BrickletRS485`PARITYUODD = 1
  • BrickletRS485`PARITYUEVEN = 2
  • BrickletRS485`STOPBITSU1 = 1
  • BrickletRS485`STOPBITSU2 = 2
  • BrickletRS485`WORDLENGTHU5 = 5
  • BrickletRS485`WORDLENGTHU6 = 6
  • BrickletRS485`WORDLENGTHU7 = 7
  • BrickletRS485`WORDLENGTHU8 = 8
  • BrickletRS485`DUPLEXUHALF = 0
  • BrickletRS485`DUPLEXUFULL = 1
BrickletRS485@SetModbusConfiguration[slaveAddress, masterRequestTimeout] → Null
Parameters:
  • slaveAddress -- Integer
  • masterRequestTimeout -- Integer

Sets the configuration for the RS485 Modbus communication. Available options:

  • Slave Address: Address to be used as the Modbus slave address in Modbus slave mode. Valid Modbus slave address range is 1 to 247.
  • Master Request Timeout: Specifies how long the master should wait for a response from a slave in milliseconds when in Modbus master mode.

The default is: Slave Address = 1 and Master Request Timeout = 1000 milliseconds (1 second).

BrickletRS485@GetModbusConfiguration[out slaveAddress, out masterRequestTimeout] → Null
Parameters:
  • slaveAddress -- Integer
  • masterRequestTimeout -- Integer

Returns the configuration as set by SetModbusConfiguration[].

BrickletRS485@SetMode[mode] → Null
Parameters:
  • mode -- Integer

Sets the mode of the Bricklet in which it operates. Available options are

  • RS485,
  • Modbus Master RTU and
  • Modbus Slave RTU.

The default is: RS485 mode.

The following constants are available for this function:

  • BrickletRS485`MODEURS485 = 0
  • BrickletRS485`MODEUMODBUSUMASTERURTU = 1
  • BrickletRS485`MODEUMODBUSUSLAVEURTU = 2
BrickletRS485@GetMode[] → mode
Returns:
  • mode -- Integer

Returns the configuration as set by SetMode[].

The following constants are available for this function:

  • BrickletRS485`MODEURS485 = 0
  • BrickletRS485`MODEUMODBUSUMASTERURTU = 1
  • BrickletRS485`MODEUMODBUSUSLAVEURTU = 2

Advanced Functions

BrickletRS485@SetCommunicationLEDConfig[config] → Null
Parameters:
  • config -- Integer

Sets the communication LED configuration. By default the LED shows RS485 communication traffic by flickering.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is off.

The following constants are available for this function:

  • BrickletRS485`COMMUNICATIONULEDUCONFIGUOFF = 0
  • BrickletRS485`COMMUNICATIONULEDUCONFIGUON = 1
  • BrickletRS485`COMMUNICATIONULEDUCONFIGUSHOWUHEARTBEAT = 2
  • BrickletRS485`COMMUNICATIONULEDUCONFIGUSHOWUCOMMUNICATION = 3
BrickletRS485@GetCommunicationLEDConfig[] → config
Returns:
  • config -- Integer

Returns the configuration as set by SetCommunicationLEDConfig[]

The following constants are available for this function:

  • BrickletRS485`COMMUNICATIONULEDUCONFIGUOFF = 0
  • BrickletRS485`COMMUNICATIONULEDUCONFIGUON = 1
  • BrickletRS485`COMMUNICATIONULEDUCONFIGUSHOWUHEARTBEAT = 2
  • BrickletRS485`COMMUNICATIONULEDUCONFIGUSHOWUCOMMUNICATION = 3
BrickletRS485@SetErrorLEDConfig[config] → Null
Parameters:
  • config -- Integer

Sets the error LED configuration.

By default the error LED turns on if there is any error (see ErrorCountCallback callback). If you call this function with the SHOW ERROR option again, the LED will turn off until the next error occurs.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is off.

The following constants are available for this function:

  • BrickletRS485`ERRORULEDUCONFIGUOFF = 0
  • BrickletRS485`ERRORULEDUCONFIGUON = 1
  • BrickletRS485`ERRORULEDUCONFIGUSHOWUHEARTBEAT = 2
  • BrickletRS485`ERRORULEDUCONFIGUSHOWUERROR = 3
BrickletRS485@GetErrorLEDConfig[] → config
Returns:
  • config -- Integer

Returns the configuration as set by SetErrorLEDConfig[].

The following constants are available for this function:

  • BrickletRS485`ERRORULEDUCONFIGUOFF = 0
  • BrickletRS485`ERRORULEDUCONFIGUON = 1
  • BrickletRS485`ERRORULEDUCONFIGUSHOWUHEARTBEAT = 2
  • BrickletRS485`ERRORULEDUCONFIGUSHOWUERROR = 3
BrickletRS485@SetBufferConfig[sendBufferSize, receiveBufferSize] → Null
Parameters:
  • sendBufferSize -- Integer
  • receiveBufferSize -- Integer

Sets the send and receive buffer size in byte. In sum there is 10240 byte (10kb) buffer available and the minimum buffer size is 1024 byte (1kb) for both.

The current buffer content is lost if this function is called.

The send buffer holds data that was given by Write[] and could not be written yet. The receive buffer holds data that is received through RS485 but could not yet be send to the user, either by Read[] or through ReadCallback callback.

The default configuration is 5120 byte (5kb) per buffer.

BrickletRS485@GetBufferConfig[out sendBufferSize, out receiveBufferSize] → Null
Parameters:
  • sendBufferSize -- Integer
  • receiveBufferSize -- Integer

Returns the buffer configuration as set by SetBufferConfig[].

BrickletRS485@GetBufferStatus[out sendBufferUsed, out receiveBufferUsed] → Null
Parameters:
  • sendBufferUsed -- Integer
  • receiveBufferUsed -- Integer

Returns the currently used bytes for the send and received buffer.

See SetBufferConfig[] for buffer size configuration.

BrickletRS485@GetErrorCount[out overrunErrorCount, out parityErrorCount] → Null
Parameters:
  • overrunErrorCount -- Integer
  • parityErrorCount -- Integer

Returns the current number of overrun and parity errors.

BrickletRS485@GetModbusCommonErrorCount[out timeoutErrorCount, out checksumErrorCount, out frameTooBigErrorCount, out illegalFunctionErrorCount, out illegalDataAddressErrorCount, out illegalDataValueErrorCount, out slaveDeviceFailureErrorCount] → Null
Parameters:
  • timeoutErrorCount -- Integer
  • checksumErrorCount -- Integer
  • frameTooBigErrorCount -- Integer
  • illegalFunctionErrorCount -- Integer
  • illegalDataAddressErrorCount -- Integer
  • illegalDataValueErrorCount -- Integer
  • slaveDeviceFailureErrorCount -- Integer

Returns the current number of errors occurred in Modbus mode.

  • Timeout Error Count: Number of timeouts occurred.
  • Checksum Error Count: Number of failures due to Modbus frame CRC16 checksum mismatch.
  • Frame Too Big Error Count: Number of times frames were rejected because they exceeded maximum Modbus frame size which is 256 bytes.
  • Illegal Function Error Count: Number of errors when an unimplemented or illegal function is requested. This corresponds to Modbus exception code 1.
  • Illegal Data Address Error Count: Number of errors due to invalid data address. This corresponds to Modbus exception code 2.
  • Illegal Data Value Error Count: Number of errors due to invalid data value. This corresponds to Modbus exception code 3.
  • Slave Device Failure Error Count: Number of errors occurred on the slave device which were unrecoverable. This corresponds to Modbus exception code 4.
BrickletRS485@ModbusSlaveReportException[requestID, exceptionCode] → Null
Parameters:
  • requestID -- Integer
  • exceptionCode -- Integer

In Modbus slave mode this function can be used to report a Modbus exception for a Modbus master request.

  • Request ID: Request ID of the request received by the slave.
  • Exception Code: Modbus exception code to report to the Modbus master.

The following constants are available for this function:

  • BrickletRS485`EXCEPTIONUCODEUTIMEOUT = -1
  • BrickletRS485`EXCEPTIONUCODEUSUCCESS = 0
  • BrickletRS485`EXCEPTIONUCODEUILLEGALUFUNCTION = 1
  • BrickletRS485`EXCEPTIONUCODEUILLEGALUDATAUADDRESS = 2
  • BrickletRS485`EXCEPTIONUCODEUILLEGALUDATAUVALUE = 3
  • BrickletRS485`EXCEPTIONUCODEUSLAVEUDEVICEUFAILURE = 4
  • BrickletRS485`EXCEPTIONUCODEUACKNOWLEDGE = 5
  • BrickletRS485`EXCEPTIONUCODEUSLAVEUDEVICEUBUSY = 6
  • BrickletRS485`EXCEPTIONUCODEUMEMORYUPARITYUERROR = 8
  • BrickletRS485`EXCEPTIONUCODEUGATEWAYUPATHUUNAVAILABLE = 10
  • BrickletRS485`EXCEPTIONUCODEUGATEWAYUTARGETUDEVICEUFAILEDUTOURESPOND = 11
BrickletRS485@ModbusSlaveAnswerReadCoilsRequest[requestID, {coils1, coils2, ...}] → Null
Parameters:
  • requestID -- Integer
  • coilsi -- True/False

In Modbus slave mode this function can be used to answer a master request to read coils.

  • Request ID: Request ID of the corresponding request that is being answered.
  • Coils: Data that is to be sent to the Modbus master for the corresponding request.

This function must be called from the ModbusSlaveReadCoilsRequestCallback callback with the Request ID as provided by the argument of the callback.

BrickletRS485@ModbusMasterReadCoils[slaveAddress, startingAddress, count] → requestID
Parameters:
  • slaveAddress -- Integer
  • startingAddress -- Integer
  • count -- Integer
Returns:
  • requestID -- Integer

In Modbus master mode this function can be used to read coils from a slave. This function creates a Modbus function code 1 request.

  • Slave Address: Address of the target Modbus slave.
  • Starting Address: Starting address of the read.
  • Count: Number of coils to read.

Upon success the function will return a non-zero request ID which will represent the current request initiated by the Modbus master. In case of failure the returned request ID will be 0.

When successful this function will also invoke the ModbusMasterReadCoilsResponseCallback callback. In this callback the Request ID provided by the callback argument must be matched with the Request ID returned from this function to verify that the callback is indeed for a particular request.

BrickletRS485@ModbusSlaveAnswerReadHoldingRegistersRequest[requestID, {holdingRegisters1, holdingRegisters2, ...}] → Null
Parameters:
  • requestID -- Integer
  • holdingRegistersi -- Integer

In Modbus slave mode this function can be used to answer a master request to read holding registers.

  • Request ID: Request ID of the corresponding request that is being answered.
  • Holding Registers: Data that is to be sent to the Modbus master for the corresponding request.

This function must be called from the ModbusSlaveReadHoldingRegistersRequestCallback callback with the Request ID as provided by the argument of the callback.

BrickletRS485@ModbusMasterReadHoldingRegisters[slaveAddress, startingAddress, count] → requestID
Parameters:
  • slaveAddress -- Integer
  • startingAddress -- Integer
  • count -- Integer
Returns:
  • requestID -- Integer

In Modbus master mode this function can be used to read holding registers from a slave. This function creates a Modbus function code 3 request.

  • Slave Address: Address of the target Modbus slave.
  • Starting Address: Starting address of the read.
  • Count: Number of holding registers to read.

Upon success the function will return a non-zero request ID which will represent the current request initiated by the Modbus master. In case of failure the returned request ID will be 0.

When successful this function will also invoke the ModbusMasterReadHoldingRegistersResponseCallback callback. In this callback the Request ID provided by the callback argument must be matched with the Request ID returned from this function to verify that the callback is indeed for a particular request.

BrickletRS485@ModbusSlaveAnswerWriteSingleCoilRequest[requestID] → Null
Parameters:
  • requestID -- Integer

In Modbus slave mode this function can be used to answer a master request to write a single coil.

  • Request ID: Request ID of the corresponding request that is being answered.

This function must be called from the ModbusSlaveWriteSingleCoilRequestCallback callback with the Request ID as provided by the arguments of the callback.

BrickletRS485@ModbusMasterWriteSingleCoil[slaveAddress, coilAddress, coilValue] → requestID
Parameters:
  • slaveAddress -- Integer
  • coilAddress -- Integer
  • coilValue -- True/False
Returns:
  • requestID -- Integer

In Modbus master mode this function can be used to write a single coil of a slave. This function creates a Modbus function code 5 request.

  • Slave Address: Address of the target Modbus slave.
  • Coil Address: Address of the coil.
  • Coil Value: Value to be written.

Upon success the function will return a non-zero request ID which will represent the current request initiated by the Modbus master. In case of failure the returned request ID will be 0.

When successful this function will also invoke the ModbusMasterWriteSingleCoilResponseCallback callback. In this callback the Request ID provided by the callback argument must be matched with the Request ID returned from this function to verify that the callback is indeed for a particular request.

BrickletRS485@ModbusSlaveAnswerWriteSingleRegisterRequest[requestID] → Null
Parameters:
  • requestID -- Integer

In Modbus slave mode this function can be used to answer a master request to write a single register.

  • Request ID: Request ID of the corresponding request that is being answered.

This function must be called from the ModbusSlaveWriteSingleRegisterRequestCallback callback with the Request ID, Register Address and Register Value as provided by the arguments of the callback.

BrickletRS485@ModbusMasterWriteSingleRegister[slaveAddress, registerAddress, registerValue] → requestID
Parameters:
  • slaveAddress -- Integer
  • registerAddress -- Integer
  • registerValue -- Integer
Returns:
  • requestID -- Integer

In Modbus master mode this function can be used to write a single register of a slave. This function creates a Modbus function code 6 request.

  • Slave Address: Address of the target Modbus slave.
  • Register Address: Address of the register.
  • Register Value: Value to be written.

Upon success the function will return a non-zero request ID which will represent the current request initiated by the Modbus master. In case of failure the returned request ID will be 0.

When successful this function will also invoke the ModbusMasterWriteSingleRegisterResponseCallback callback. In this callback the Request ID provided by the callback argument must be matched with the Request ID returned from this function to verify that the callback is indeed for a particular request.

BrickletRS485@ModbusSlaveAnswerWriteMultipleCoilsRequest[requestID] → Null
Parameters:
  • requestID -- Integer

In Modbus slave mode this function can be used to answer a master request to write multiple coils.

  • Request ID: Request ID of the corresponding request that is being answered.

This function must be called from the ModbusSlaveWriteMultipleCoilsRequestCallback callback with the Request ID of the callback.

BrickletRS485@ModbusMasterWriteMultipleCoils[slaveAddress, startingAddress, {coils1, coils2, ...}] → requestID
Parameters:
  • slaveAddress -- Integer
  • startingAddress -- Integer
  • coilsi -- True/False
Returns:
  • requestID -- Integer

In Modbus master mode this function can be used to write multiple coils of a slave. This function creates a Modbus function code 15 request.

  • Slave Address: Address of the target Modbus slave.
  • Starting Address: Starting address of the write.

Upon success the function will return a non-zero request ID which will represent the current request initiated by the Modbus master. In case of failure the returned request ID will be 0.

When successful this function will also invoke the ModbusMasterWriteMultipleCoilsResponseCallback callback. In this callback the Request ID provided by the callback argument must be matched with the Request ID returned from this function to verify that the callback is indeed for a particular request.

BrickletRS485@ModbusSlaveAnswerWriteMultipleRegistersRequest[requestID] → Null
Parameters:
  • requestID -- Integer

In Modbus slave mode this function can be used to answer a master request to write multiple registers.

  • Request ID: Request ID of the corresponding request that is being answered.

This function must be called from the ModbusSlaveWriteMultipleRegistersRequestCallback callback with the Request ID of the callback.

BrickletRS485@ModbusMasterWriteMultipleRegisters[slaveAddress, startingAddress, {registers1, registers2, ...}] → requestID
Parameters:
  • slaveAddress -- Integer
  • startingAddress -- Integer
  • registersi -- Integer
Returns:
  • requestID -- Integer

In Modbus master mode this function can be used to write multiple registers of a slave. This function creates a Modbus function code 16 request.

  • Slave Address: Address of the target Modbus slave.
  • Starting Address: Starting Address of the write.

Upon success the function will return a non-zero request ID which will represent the current request initiated by the Modbus master. In case of failure the returned request ID will be 0.

When successful this function will also invoke the ModbusMasterWriteMultipleRegistersResponseCallback callback. In this callback the Request ID provided by the callback argument must be matched with the Request ID returned from this function to verify that the callback is indeed for a particular request.

BrickletRS485@ModbusSlaveAnswerReadDiscreteInputsRequest[requestID, {discreteInputs1, discreteInputs2, ...}] → Null
Parameters:
  • requestID -- Integer
  • discreteInputsi -- True/False

In Modbus slave mode this function can be used to answer a master request to read discrete inputs.

  • Request ID: Request ID of the corresponding request that is being answered.
  • Discrete Inputs: Data that is to be sent to the Modbus master for the corresponding request.

This function must be called from the ModbusSlaveReadDiscreteInputsRequestCallback callback with the Request ID as provided by the argument of the callback.

BrickletRS485@ModbusMasterReadDiscreteInputs[slaveAddress, startingAddress, count] → requestID
Parameters:
  • slaveAddress -- Integer
  • startingAddress -- Integer
  • count -- Integer
Returns:
  • requestID -- Integer

In Modbus master mode this function can be used to read discrete inputs from a slave. This function creates a Modbus function code 2 request.

  • Slave Address: Address of the target Modbus slave.
  • Starting Address: Starting address of the read.
  • Count: Number of discrete inputs to read.

Upon success the function will return a non-zero request ID which will represent the current request initiated by the Modbus master. In case of failure the returned request ID will be 0.

When successful this function will also invoke the ModbusMasterReadDiscreteInputsResponseCallback callback. In this callback the Request ID provided by the callback argument must be matched with the Request ID returned from this function to verify that the callback is indeed for a particular request.

BrickletRS485@ModbusSlaveAnswerReadInputRegistersRequest[requestID, {inputRegisters1, inputRegisters2, ...}] → Null
Parameters:
  • requestID -- Integer
  • inputRegistersi -- Integer

In Modbus slave mode this function can be used to answer a master request to read input registers.

  • Request ID: Request ID of the corresponding request that is being answered.
  • Input Registers: Data that is to be sent to the Modbus master for the corresponding request.

This function must be called from the ModbusSlaveReadInputRegistersRequestCallback callback with the Request ID as provided by the argument of the callback.

BrickletRS485@ModbusMasterReadInputRegisters[slaveAddress, startingAddress, count] → requestID
Parameters:
  • slaveAddress -- Integer
  • startingAddress -- Integer
  • count -- Integer
Returns:
  • requestID -- Integer

In Modbus master mode this function can be used to read input registers from a slave. This function creates a Modbus function code 4 request.

  • Slave Address: Address of the target Modbus slave.
  • Starting Address: Starting address of the read.
  • Count: Number of input registers to read.

Upon success the function will return a non-zero request ID which will represent the current request initiated by the Modbus master. In case of failure the returned request ID will be 0.

When successful this function will also invoke the ModbusMasterReadInputRegistersResponseCallback callback. In this callback the Request ID provided by the callback argument must be matched with the Request ID returned from this function to verify that the callback is indeed for a particular request.

BrickletRS485@GetAPIVersion[] → {apiVersion1, apiVersion2, apiVersion3}
Returns:
  • apiVersioni -- Integer

Returns the version of the API definition (major, minor, revision) implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

BrickletRS485@GetResponseExpected[functionId] → responseExpected
Parameters:
  • functionId -- Integer
Returns:
  • responseExpected -- True/False

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by SetResponseExpected[]. For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

See SetResponseExpected[] for the list of function ID constants available for this function.

BrickletRS485@SetResponseExpected[functionId, responseExpected] → Null
Parameters:
  • functionId -- Integer
  • responseExpected -- True/False

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

The following function ID constants are available for this function:

  • BrickletRS485`FUNCTIONUENABLEUREADUCALLBACK = 3
  • BrickletRS485`FUNCTIONUDISABLEUREADUCALLBACK = 4
  • BrickletRS485`FUNCTIONUSETURS485UCONFIGURATION = 6
  • BrickletRS485`FUNCTIONUSETUMODBUSUCONFIGURATION = 8
  • BrickletRS485`FUNCTIONUSETUMODE = 10
  • BrickletRS485`FUNCTIONUSETUCOMMUNICATIONULEDUCONFIG = 12
  • BrickletRS485`FUNCTIONUSETUERRORULEDUCONFIG = 14
  • BrickletRS485`FUNCTIONUSETUBUFFERUCONFIG = 16
  • BrickletRS485`FUNCTIONUENABLEUERRORUCOUNTUCALLBACK = 19
  • BrickletRS485`FUNCTIONUDISABLEUERRORUCOUNTUCALLBACK = 20
  • BrickletRS485`FUNCTIONUMODBUSUSLAVEUREPORTUEXCEPTION = 24
  • BrickletRS485`FUNCTIONUMODBUSUSLAVEUANSWERUREADUCOILSUREQUEST = 25
  • BrickletRS485`FUNCTIONUMODBUSUSLAVEUANSWERUREADUHOLDINGUREGISTERSUREQUEST = 27
  • BrickletRS485`FUNCTIONUMODBUSUSLAVEUANSWERUWRITEUSINGLEUCOILUREQUEST = 29
  • BrickletRS485`FUNCTIONUMODBUSUSLAVEUANSWERUWRITEUSINGLEUREGISTERUREQUEST = 31
  • BrickletRS485`FUNCTIONUMODBUSUSLAVEUANSWERUWRITEUMULTIPLEUCOILSUREQUEST = 33
  • BrickletRS485`FUNCTIONUMODBUSUSLAVEUANSWERUWRITEUMULTIPLEUREGISTERSUREQUEST = 35
  • BrickletRS485`FUNCTIONUMODBUSUSLAVEUANSWERUREADUDISCRETEUINPUTSUREQUEST = 37
  • BrickletRS485`FUNCTIONUMODBUSUSLAVEUANSWERUREADUINPUTUREGISTERSUREQUEST = 39
  • BrickletRS485`FUNCTIONUSETUWRITEUFIRMWAREUPOINTER = 237
  • BrickletRS485`FUNCTIONUSETUSTATUSULEDUCONFIG = 239
  • BrickletRS485`FUNCTIONURESET = 243
  • BrickletRS485`FUNCTIONUWRITEUUID = 248
BrickletRS485@SetResponseExpectedAll[responseExpected] → Null
Parameters:
  • responseExpected -- True/False

Changes the response expected flag for all setter and callback configuration functions of this device at once.

BrickletRS485@GetSPITFPErrorCount[out errorCountAckChecksum, out errorCountMessageChecksum, out errorCountFrame, out errorCountOverflow] → Null
Parameters:
  • errorCountAckChecksum -- Integer
  • errorCountMessageChecksum -- Integer
  • errorCountFrame -- Integer
  • errorCountOverflow -- Integer

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

  • ACK checksum errors,
  • message checksum errors,
  • framing errors and
  • overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

BrickletRS485@SetBootloaderMode[mode] → status
Parameters:
  • mode -- Integer
Returns:
  • status -- Integer

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

The following constants are available for this function:

  • BrickletRS485`BOOTLOADERUMODEUBOOTLOADER = 0
  • BrickletRS485`BOOTLOADERUMODEUFIRMWARE = 1
  • BrickletRS485`BOOTLOADERUMODEUBOOTLOADERUWAITUFORUREBOOT = 2
  • BrickletRS485`BOOTLOADERUMODEUFIRMWAREUWAITUFORUREBOOT = 3
  • BrickletRS485`BOOTLOADERUMODEUFIRMWAREUWAITUFORUERASEUANDUREBOOT = 4
  • BrickletRS485`BOOTLOADERUSTATUSUOK = 0
  • BrickletRS485`BOOTLOADERUSTATUSUINVALIDUMODE = 1
  • BrickletRS485`BOOTLOADERUSTATUSUNOUCHANGE = 2
  • BrickletRS485`BOOTLOADERUSTATUSUENTRYUFUNCTIONUNOTUPRESENT = 3
  • BrickletRS485`BOOTLOADERUSTATUSUDEVICEUIDENTIFIERUINCORRECT = 4
  • BrickletRS485`BOOTLOADERUSTATUSUCRCUMISMATCH = 5
BrickletRS485@GetBootloaderMode[] → mode
Returns:
  • mode -- Integer

Returns the current bootloader mode, see SetBootloaderMode[].

The following constants are available for this function:

  • BrickletRS485`BOOTLOADERUMODEUBOOTLOADER = 0
  • BrickletRS485`BOOTLOADERUMODEUFIRMWARE = 1
  • BrickletRS485`BOOTLOADERUMODEUBOOTLOADERUWAITUFORUREBOOT = 2
  • BrickletRS485`BOOTLOADERUMODEUFIRMWAREUWAITUFORUREBOOT = 3
  • BrickletRS485`BOOTLOADERUMODEUFIRMWAREUWAITUFORUERASEUANDUREBOOT = 4
BrickletRS485@SetWriteFirmwarePointer[pointer] → Null
Parameters:
  • pointer -- Integer

Sets the firmware pointer for WriteFirmware[]. The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

BrickletRS485@WriteFirmware[{data1, data2, ..., data64}] → status
Parameters:
  • datai -- Integer
Returns:
  • status -- Integer

Writes 64 Bytes of firmware at the position as written by SetWriteFirmwarePointer[] before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

BrickletRS485@SetStatusLEDConfig[config] → Null
Parameters:
  • config -- Integer

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

The following constants are available for this function:

  • BrickletRS485`STATUSULEDUCONFIGUOFF = 0
  • BrickletRS485`STATUSULEDUCONFIGUON = 1
  • BrickletRS485`STATUSULEDUCONFIGUSHOWUHEARTBEAT = 2
  • BrickletRS485`STATUSULEDUCONFIGUSHOWUSTATUS = 3
BrickletRS485@GetStatusLEDConfig[] → config
Returns:
  • config -- Integer

Returns the configuration as set by SetStatusLEDConfig[]

The following constants are available for this function:

  • BrickletRS485`STATUSULEDUCONFIGUOFF = 0
  • BrickletRS485`STATUSULEDUCONFIGUON = 1
  • BrickletRS485`STATUSULEDUCONFIGUSHOWUHEARTBEAT = 2
  • BrickletRS485`STATUSULEDUCONFIGUSHOWUSTATUS = 3
BrickletRS485@GetChipTemperature[] → temperature
Returns:
  • temperature -- Integer

Returns the temperature in °C as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

BrickletRS485@Reset[] → Null

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

BrickletRS485@WriteUID[uid] → Null
Parameters:
  • uid -- Integer

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

BrickletRS485@ReadUID[] → uid
Returns:
  • uid -- Integer

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

BrickletRS485@GetIdentity[out uid, out connectedUid, out position, out {hardwareVersion1, hardwareVersion2, hardwareVersion3}, out {firmwareVersion1, firmwareVersion2, firmwareVersion3}, out deviceIdentifier] → Null
Parameters:
  • uid -- String
  • connectedUid -- String
  • position -- Integer
  • hardwareVersioni -- Integer
  • firmwareVersioni -- Integer
  • deviceIdentifier -- Integer

Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be 'a', 'b', 'c' or 'd'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions

BrickletRS485@EnableReadCallback[] → Null

Enables the ReadCallback callback.

By default the callback is disabled.

BrickletRS485@DisableReadCallback[] → Null

Disables the ReadCallback callback.

By default the callback is disabled.

BrickletRS485@IsReadCallbackEnabled[] → enabled
Returns:
  • enabled -- True/False

Returns true if the ReadCallback callback is enabled, false otherwise.

BrickletRS485@EnableErrorCountCallback[] → Null

Enables the ErrorCountCallback callback.

By default the callback is disabled.

BrickletRS485@DisableErrorCountCallback[] → Null

Disables the ErrorCountCallback callback.

By default the callback is disabled.

BrickletRS485@IsErrorCountCallbackEnabled[] → enabled
Returns:
  • enabled -- True/False

Returns true if the ErrorCountCallback callback is enabled, false otherwise.

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done by assigning a function to a callback property of the device object:

MyCallback[sender_,value_]:=Print["Value: "<>ToString[value]]

AddEventHandler[rs485@ExampleCallback,MyCallback]

For further information about event handling using .NET/Link see the corresponding Mathematica .NET/Link documentation.

The available callback property and their type of parameters are described below.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

event BrickletRS485@ReadCallback[sender, {message1, message2, ...}]
Parameters:
  • sender -- NETObject[BrickletRS485]
  • messagei -- Integer

This callback is called if new data is available.

To enable this callback, use EnableReadCallback[].

event BrickletRS485@ErrorCountCallback[sender, overrunErrorCount, parityErrorCount]
Parameters:
  • sender -- NETObject[BrickletRS485]
  • overrunErrorCount -- Integer
  • parityErrorCount -- Integer

This callback is called if a new error occurs. It returns the current overrun and parity error count.

event BrickletRS485@ModbusSlaveReadCoilsRequestCallback[sender, requestID, startingAddress, count]
Parameters:
  • sender -- NETObject[BrickletRS485]
  • requestID -- Integer
  • startingAddress -- Integer
  • count -- Integer

This callback is called only in Modbus slave mode when the slave receives a valid request from a Modbus master to read coils. The parameters are request ID of the request, the starting address and the number of coils to be read as received by the request.

To send a response of this request use ModbusSlaveAnswerReadCoilsRequest[].

event BrickletRS485@ModbusMasterReadCoilsResponseCallback[sender, requestID, exceptionCode, {coils1, coils2, ...}]
Parameters:
  • sender -- NETObject[BrickletRS485]
  • requestID -- Integer
  • exceptionCode -- Integer
  • coilsi -- True/False

This callback is called only in Modbus master mode when the master receives a valid response of a request to read coils.

The parameters are request ID of the request, exception code of the response and the data as received by the response.

Any non-zero exception code indicates a problem. If the exception code is greater than zero then the number represents a Modbus exception code. If it is less than zero then it represents other errors. For example, -1 indicates that the request timed out or that the master did not receive any valid response of the request within the master request timeout period as set by SetModbusConfiguration[].

The following constants are available for this function:

  • BrickletRS485`EXCEPTIONUCODEUTIMEOUT = -1
  • BrickletRS485`EXCEPTIONUCODEUSUCCESS = 0
  • BrickletRS485`EXCEPTIONUCODEUILLEGALUFUNCTION = 1
  • BrickletRS485`EXCEPTIONUCODEUILLEGALUDATAUADDRESS = 2
  • BrickletRS485`EXCEPTIONUCODEUILLEGALUDATAUVALUE = 3
  • BrickletRS485`EXCEPTIONUCODEUSLAVEUDEVICEUFAILURE = 4
  • BrickletRS485`EXCEPTIONUCODEUACKNOWLEDGE = 5
  • BrickletRS485`EXCEPTIONUCODEUSLAVEUDEVICEUBUSY = 6
  • BrickletRS485`EXCEPTIONUCODEUMEMORYUPARITYUERROR = 8
  • BrickletRS485`EXCEPTIONUCODEUGATEWAYUPATHUUNAVAILABLE = 10
  • BrickletRS485`EXCEPTIONUCODEUGATEWAYUTARGETUDEVICEUFAILEDUTOURESPOND = 11
event BrickletRS485@ModbusSlaveReadHoldingRegistersRequestCallback[sender, requestID, startingAddress, count]
Parameters:
  • sender -- NETObject[BrickletRS485]
  • requestID -- Integer
  • startingAddress -- Integer
  • count -- Integer

This callback is called only in Modbus slave mode when the slave receives a valid request from a Modbus master to read holding registers. The parameters are request ID of the request, the starting address and the number of holding registers to be read as received by the request.

To send a response of this request use ModbusSlaveAnswerReadHoldingRegistersRequest[].

event BrickletRS485@ModbusMasterReadHoldingRegistersResponseCallback[sender, requestID, exceptionCode, {holdingRegisters1, holdingRegisters2, ...}]
Parameters:
  • sender -- NETObject[BrickletRS485]
  • requestID -- Integer
  • exceptionCode -- Integer
  • holdingRegistersi -- Integer

This callback is called only in Modbus master mode when the master receives a valid response of a request to read holding registers.

The parameters are request ID of the request, exception code of the response and the data as received by the response.

Any non-zero exception code indicates a problem. If the exception code is greater than zero then the number represents a Modbus exception code. If it is less than zero then it represents other errors. For example, -1 indicates that the request timed out or that the master did not receive any valid response of the request within the master request timeout period as set by SetModbusConfiguration[].

The following constants are available for this function:

  • BrickletRS485`EXCEPTIONUCODEUTIMEOUT = -1
  • BrickletRS485`EXCEPTIONUCODEUSUCCESS = 0
  • BrickletRS485`EXCEPTIONUCODEUILLEGALUFUNCTION = 1
  • BrickletRS485`EXCEPTIONUCODEUILLEGALUDATAUADDRESS = 2
  • BrickletRS485`EXCEPTIONUCODEUILLEGALUDATAUVALUE = 3
  • BrickletRS485`EXCEPTIONUCODEUSLAVEUDEVICEUFAILURE = 4
  • BrickletRS485`EXCEPTIONUCODEUACKNOWLEDGE = 5
  • BrickletRS485`EXCEPTIONUCODEUSLAVEUDEVICEUBUSY = 6
  • BrickletRS485`EXCEPTIONUCODEUMEMORYUPARITYUERROR = 8
  • BrickletRS485`EXCEPTIONUCODEUGATEWAYUPATHUUNAVAILABLE = 10
  • BrickletRS485`EXCEPTIONUCODEUGATEWAYUTARGETUDEVICEUFAILEDUTOURESPOND = 11
event BrickletRS485@ModbusSlaveWriteSingleCoilRequestCallback[sender, requestID, coilAddress, coilValue]
Parameters:
  • sender -- NETObject[BrickletRS485]
  • requestID -- Integer
  • coilAddress -- Integer
  • coilValue -- True/False

This callback is called only in Modbus slave mode when the slave receives a valid request from a Modbus master to write a single coil. The parameters are request ID of the request, the coil address and the value of coil to be written as received by the request.

To send a response of this request use ModbusSlaveAnswerWriteSingleCoilRequest[].

event BrickletRS485@ModbusMasterWriteSingleCoilResponseCallback[sender, requestID, exceptionCode]
Parameters:
  • sender -- NETObject[BrickletRS485]
  • requestID -- Integer
  • exceptionCode -- Integer

This callback is called only in Modbus master mode when the master receives a valid response of a request to write a single coil.

The parameters are request ID of the request and exception code of the response.

Any non-zero exception code indicates a problem. If the exception code is greater than zero then the number represents a Modbus exception code. If it is less than zero then it represents other errors. For example, -1 indicates that the request timed out or that the master did not receive any valid response of the request within the master request timeout period as set by SetModbusConfiguration[].

The following constants are available for this function:

  • BrickletRS485`EXCEPTIONUCODEUTIMEOUT = -1
  • BrickletRS485`EXCEPTIONUCODEUSUCCESS = 0
  • BrickletRS485`EXCEPTIONUCODEUILLEGALUFUNCTION = 1
  • BrickletRS485`EXCEPTIONUCODEUILLEGALUDATAUADDRESS = 2
  • BrickletRS485`EXCEPTIONUCODEUILLEGALUDATAUVALUE = 3
  • BrickletRS485`EXCEPTIONUCODEUSLAVEUDEVICEUFAILURE = 4
  • BrickletRS485`EXCEPTIONUCODEUACKNOWLEDGE = 5
  • BrickletRS485`EXCEPTIONUCODEUSLAVEUDEVICEUBUSY = 6
  • BrickletRS485`EXCEPTIONUCODEUMEMORYUPARITYUERROR = 8
  • BrickletRS485`EXCEPTIONUCODEUGATEWAYUPATHUUNAVAILABLE = 10
  • BrickletRS485`EXCEPTIONUCODEUGATEWAYUTARGETUDEVICEUFAILEDUTOURESPOND = 11
event BrickletRS485@ModbusSlaveWriteSingleRegisterRequestCallback[sender, requestID, registerAddress, registerValue]
Parameters:
  • sender -- NETObject[BrickletRS485]
  • requestID -- Integer
  • registerAddress -- Integer
  • registerValue -- Integer

This callback is called only in Modbus slave mode when the slave receives a valid request from a Modbus master to write a single register. The parameters are request ID of the request, the register address and the register value to be written as received by the request.

To send a response of this request use ModbusSlaveAnswerWriteSingleRegisterRequest[].

event BrickletRS485@ModbusMasterWriteSingleRegisterResponseCallback[sender, requestID, exceptionCode]
Parameters:
  • sender -- NETObject[BrickletRS485]
  • requestID -- Integer
  • exceptionCode -- Integer

This callback is called only in Modbus master mode when the master receives a valid response of a request to write a single register.

The parameters are request ID of the request and exception code of the response.

Any non-zero exception code indicates a problem. If the exception code is greater than zero then the number represents a Modbus exception code. If it is less than zero then it represents other errors. For example, -1 indicates that the request timed out or that the master did not receive any valid response of the request within the master request timeout period as set by SetModbusConfiguration[].

The following constants are available for this function:

  • BrickletRS485`EXCEPTIONUCODEUTIMEOUT = -1
  • BrickletRS485`EXCEPTIONUCODEUSUCCESS = 0
  • BrickletRS485`EXCEPTIONUCODEUILLEGALUFUNCTION = 1
  • BrickletRS485`EXCEPTIONUCODEUILLEGALUDATAUADDRESS = 2
  • BrickletRS485`EXCEPTIONUCODEUILLEGALUDATAUVALUE = 3
  • BrickletRS485`EXCEPTIONUCODEUSLAVEUDEVICEUFAILURE = 4
  • BrickletRS485`EXCEPTIONUCODEUACKNOWLEDGE = 5
  • BrickletRS485`EXCEPTIONUCODEUSLAVEUDEVICEUBUSY = 6
  • BrickletRS485`EXCEPTIONUCODEUMEMORYUPARITYUERROR = 8
  • BrickletRS485`EXCEPTIONUCODEUGATEWAYUPATHUUNAVAILABLE = 10
  • BrickletRS485`EXCEPTIONUCODEUGATEWAYUTARGETUDEVICEUFAILEDUTOURESPOND = 11
event BrickletRS485@ModbusSlaveWriteMultipleCoilsRequestCallback[sender, requestID, startingAddress, {coils1, coils2, ...}]
Parameters:
  • sender -- NETObject[BrickletRS485]
  • requestID -- Integer
  • startingAddress -- Integer
  • coilsi -- True/False

This callback is called only in Modbus slave mode when the slave receives a valid request from a Modbus master to write multiple coils. The parameters are request ID of the request, the starting address and the data to be written as received by the request.

To send a response of this request use ModbusSlaveAnswerWriteMultipleCoilsRequest[].

event BrickletRS485@ModbusMasterWriteMultipleCoilsResponseCallback[sender, requestID, exceptionCode]
Parameters:
  • sender -- NETObject[BrickletRS485]
  • requestID -- Integer
  • exceptionCode -- Integer

This callback is called only in Modbus master mode when the master receives a valid response of a request to read coils.

The parameters are request ID of the request and exception code of the response.

Any non-zero exception code indicates a problem. If the exception code is greater than zero then the number represents a Modbus exception code. If it is less than zero then it represents other errors. For example, -1 indicates that the request timedout or that the master did not receive any valid response of the request within the master request timeout period as set by SetModbusConfiguration[].

The following constants are available for this function:

  • BrickletRS485`EXCEPTIONUCODEUTIMEOUT = -1
  • BrickletRS485`EXCEPTIONUCODEUSUCCESS = 0
  • BrickletRS485`EXCEPTIONUCODEUILLEGALUFUNCTION = 1
  • BrickletRS485`EXCEPTIONUCODEUILLEGALUDATAUADDRESS = 2
  • BrickletRS485`EXCEPTIONUCODEUILLEGALUDATAUVALUE = 3
  • BrickletRS485`EXCEPTIONUCODEUSLAVEUDEVICEUFAILURE = 4
  • BrickletRS485`EXCEPTIONUCODEUACKNOWLEDGE = 5
  • BrickletRS485`EXCEPTIONUCODEUSLAVEUDEVICEUBUSY = 6
  • BrickletRS485`EXCEPTIONUCODEUMEMORYUPARITYUERROR = 8
  • BrickletRS485`EXCEPTIONUCODEUGATEWAYUPATHUUNAVAILABLE = 10
  • BrickletRS485`EXCEPTIONUCODEUGATEWAYUTARGETUDEVICEUFAILEDUTOURESPOND = 11
event BrickletRS485@ModbusSlaveWriteMultipleRegistersRequestCallback[sender, requestID, startingAddress, {registers1, registers2, ...}]
Parameters:
  • sender -- NETObject[BrickletRS485]
  • requestID -- Integer
  • startingAddress -- Integer
  • registersi -- Integer

This callback is called only in Modbus slave mode when the slave receives a valid request from a Modbus master to write multiple registers. The parameters are request ID of the request, the starting address and the data to be written as received by the request.

To send a response of this request use ModbusSlaveAnswerWriteMultipleRegistersRequest[].

event BrickletRS485@ModbusMasterWriteMultipleRegistersResponseCallback[sender, requestID, exceptionCode]
Parameters:
  • sender -- NETObject[BrickletRS485]
  • requestID -- Integer
  • exceptionCode -- Integer

This callback is called only in Modbus master mode when the master receives a valid response of a request to write multiple registers.

The parameters are request ID of the request and exception code of the response.

Any non-zero exception code indicates a problem. If the exception code is greater than zero then the number represents a Modbus exception code. If it is less than zero then it represents other errors. For example, -1 indicates that the request timedout or that the master did not receive any valid response of the request within the master request timeout period as set by SetModbusConfiguration[].

The following constants are available for this function:

  • BrickletRS485`EXCEPTIONUCODEUTIMEOUT = -1
  • BrickletRS485`EXCEPTIONUCODEUSUCCESS = 0
  • BrickletRS485`EXCEPTIONUCODEUILLEGALUFUNCTION = 1
  • BrickletRS485`EXCEPTIONUCODEUILLEGALUDATAUADDRESS = 2
  • BrickletRS485`EXCEPTIONUCODEUILLEGALUDATAUVALUE = 3
  • BrickletRS485`EXCEPTIONUCODEUSLAVEUDEVICEUFAILURE = 4
  • BrickletRS485`EXCEPTIONUCODEUACKNOWLEDGE = 5
  • BrickletRS485`EXCEPTIONUCODEUSLAVEUDEVICEUBUSY = 6
  • BrickletRS485`EXCEPTIONUCODEUMEMORYUPARITYUERROR = 8
  • BrickletRS485`EXCEPTIONUCODEUGATEWAYUPATHUUNAVAILABLE = 10
  • BrickletRS485`EXCEPTIONUCODEUGATEWAYUTARGETUDEVICEUFAILEDUTOURESPOND = 11
event BrickletRS485@ModbusSlaveReadDiscreteInputsRequestCallback[sender, requestID, startingAddress, count]
Parameters:
  • sender -- NETObject[BrickletRS485]
  • requestID -- Integer
  • startingAddress -- Integer
  • count -- Integer

This callback is called only in Modbus slave mode when the slave receives a valid request from a Modbus master to read discrete inputs. The parameters are request ID of the request, the starting address and the number of discrete inputs to be read as received by the request.

To send a response of this request use ModbusSlaveAnswerReadDiscreteInputsRequest[].

event BrickletRS485@ModbusMasterReadDiscreteInputsResponseCallback[sender, requestID, exceptionCode, {discreteInputs1, discreteInputs2, ...}]
Parameters:
  • sender -- NETObject[BrickletRS485]
  • requestID -- Integer
  • exceptionCode -- Integer
  • discreteInputsi -- True/False

This callback is called only in Modbus master mode when the master receives a valid response of a request to read discrete inputs.

The parameters are request ID of the request, exception code of the response and the data as received by the response.

Any non-zero exception code indicates a problem. If the exception code is greater than zero then the number represents a Modbus exception code. If it is less than zero then it represents other errors. For example, -1 indicates that the request timedout or that the master did not receive any valid response of the request within the master request timeout period as set by SetModbusConfiguration[].

The following constants are available for this function:

  • BrickletRS485`EXCEPTIONUCODEUTIMEOUT = -1
  • BrickletRS485`EXCEPTIONUCODEUSUCCESS = 0
  • BrickletRS485`EXCEPTIONUCODEUILLEGALUFUNCTION = 1
  • BrickletRS485`EXCEPTIONUCODEUILLEGALUDATAUADDRESS = 2
  • BrickletRS485`EXCEPTIONUCODEUILLEGALUDATAUVALUE = 3
  • BrickletRS485`EXCEPTIONUCODEUSLAVEUDEVICEUFAILURE = 4
  • BrickletRS485`EXCEPTIONUCODEUACKNOWLEDGE = 5
  • BrickletRS485`EXCEPTIONUCODEUSLAVEUDEVICEUBUSY = 6
  • BrickletRS485`EXCEPTIONUCODEUMEMORYUPARITYUERROR = 8
  • BrickletRS485`EXCEPTIONUCODEUGATEWAYUPATHUUNAVAILABLE = 10
  • BrickletRS485`EXCEPTIONUCODEUGATEWAYUTARGETUDEVICEUFAILEDUTOURESPOND = 11
event BrickletRS485@ModbusSlaveReadInputRegistersRequestCallback[sender, requestID, startingAddress, count]
Parameters:
  • sender -- NETObject[BrickletRS485]
  • requestID -- Integer
  • startingAddress -- Integer
  • count -- Integer

This callback is called only in Modbus slave mode when the slave receives a valid request from a Modbus master to read input registers. The parameters are request ID of the request, the starting address and the number of input registers to be read as received by the request.

To send a response of this request use ModbusSlaveAnswerReadInputRegistersRequest[].

event BrickletRS485@ModbusMasterReadInputRegistersResponseCallback[sender, requestID, exceptionCode, {inputRegisters1, inputRegisters2, ...}]
Parameters:
  • sender -- NETObject[BrickletRS485]
  • requestID -- Integer
  • exceptionCode -- Integer
  • inputRegistersi -- Integer

This callback is called only in Modbus master mode when the master receives a valid response of a request to read input registers.

The parameters are request ID of the request, exception code of the response and the data as received by the response.

Any non-zero exception code indicates a problem. If the exception code is greater than zero then the number represents a Modbus exception code. If it is less than zero then it represents other errors. For example, -1 indicates that the request timedout or that the master did not receive any valid response of the request within the master request timeout period as set by SetModbusConfiguration[].

The following constants are available for this function:

  • BrickletRS485`EXCEPTIONUCODEUTIMEOUT = -1
  • BrickletRS485`EXCEPTIONUCODEUSUCCESS = 0
  • BrickletRS485`EXCEPTIONUCODEUILLEGALUFUNCTION = 1
  • BrickletRS485`EXCEPTIONUCODEUILLEGALUDATAUADDRESS = 2
  • BrickletRS485`EXCEPTIONUCODEUILLEGALUDATAUVALUE = 3
  • BrickletRS485`EXCEPTIONUCODEUSLAVEUDEVICEUFAILURE = 4
  • BrickletRS485`EXCEPTIONUCODEUACKNOWLEDGE = 5
  • BrickletRS485`EXCEPTIONUCODEUSLAVEUDEVICEUBUSY = 6
  • BrickletRS485`EXCEPTIONUCODEUMEMORYUPARITYUERROR = 8
  • BrickletRS485`EXCEPTIONUCODEUGATEWAYUPATHUUNAVAILABLE = 10
  • BrickletRS485`EXCEPTIONUCODEUGATEWAYUTARGETUDEVICEUFAILEDUTOURESPOND = 11

Constants

BrickletRS485`DEVICEUIDENTIFIER

This constant is used to identify a RS485 Bricklet.

The GetIdentity[] function and the EnumerateCallback callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

BrickletRS485`DEVICEDISPLAYNAME

This constant represents the human readable name of a RS485 Bricklet.