Package org.openhab.core.io.transport.modbus.json

Class WriteRequestJsonUtilities

java.lang.Object

org.openhab.core.io.transport.modbus.json.WriteRequestJsonUtilities

@NonNullByDefault
public final class WriteRequestJsonUtilities
extends Object

Utilities for converting JSON to ModbusWriteRequestBlueprint

Author:

Sami Salonen - Initial contribution

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_MAX_TRIES	Default maxTries when it has not been specified
static final String	JSON_ADDRESS	Constant for the write address key in the JSON
static final String	JSON_FUNCTION_CODE	Constant for the function code key in the JSON
static final String	JSON_MAX_TRIES	Constant for the maxTries key in the JSON
static final String	JSON_VALUE	Constant for the value key in the JSON

Method Summary

Modifier and Type	Method	Description
static Collection<ModbusWriteRequestBlueprint>	fromJson(int unitId, String jsonString)	Parse JSON string to collection of ModbusWriteRequestBlueprint JSON string should represent a JSON array, with JSON objects.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

JSON_FUNCTION_CODE

public static final String JSON_FUNCTION_CODE

Constant for the function code key in the JSON

See Also:

• Constant Field Values

JSON_ADDRESS

public static final String JSON_ADDRESS

Constant for the write address key in the JSON

See Also:

• Constant Field Values

JSON_VALUE

public static final String JSON_VALUE

Constant for the value key in the JSON

See Also:

• Constant Field Values

JSON_MAX_TRIES

public static final String JSON_MAX_TRIES

Constant for the maxTries key in the JSON

See Also:

• Constant Field Values

DEFAULT_MAX_TRIES

public static final int DEFAULT_MAX_TRIES

Default maxTries when it has not been specified

See Also:

• Constant Field Values

Method Details

fromJson

public static Collection<ModbusWriteRequestBlueprint> fromJson(int unitId,
 String jsonString)

Parse JSON string to collection of ModbusWriteRequestBlueprint JSON string should represent a JSON array, with JSON objects. Each JSON object represents a write request. The JSON object must have the following keys - functionCode: numeric function code - address: reference or start address of the write - value: array of data to be written. Use zero and one when writing coils. With registers, each number corresponds to register's 16 bit data. - maxTries: number of tries with the write in case of errors

Parameters:

unitId - unit id for the constructed ModbusWriteRequestBlueprint

jsonString - json to be parsed in string format

Returns:

collection of ModbusWriteRequestBlueprint representing the json

Throws:

IllegalArgumentException - in case of unexpected function codes, or too large payload exceeding modbus protocol specification

IllegalStateException - in case of parsing errors and unexpected json structure

See Also:

• JSON_FUNCTION_CODE
• JSON_ADDRESS
• JSON_VALUE
• JSON_MAX_TRIES