Package io.openems.edge.app.common.props

Class CommunicationProps

java.lang.Object

io.openems.edge.app.common.props.CommunicationProps

public final class CommunicationProps
extends Object

Method Summary

Modifier and Type	Method	Description
static final AppDef<OpenemsApp,Nameable,Type.Parameter.BundleProvider>	ip()	Creates a AppDef for a ip-address.
static final <APP extends OpenemsApp & ComponentManagerSupplier & ComponentUtilSupplier, PROP extends Nameable, PARAM extends Type.Parameter.BundleProvider> AppDef<APP,PROP,PARAM>	modbusGroup(PROP modbusId, AppDef<? super APP,? super PROP,? super PARAM> modbusIdDef, PROP modbusUnitId, AppDef<? super APP,? super PROP,? super PARAM> modbusUnitIdDef)	Creates a AppDef group of a ComponentProps.pickModbusId() and a modbusUnitId() to check if the current selected modbus unit id already got selected.
static final <APP extends OpenemsApp & ComponentManagerSupplier & ComponentUtilSupplier, PROP extends Nameable, PARAM extends Type.Parameter.BundleProvider> AppDef<APP,PROP,PARAM>	modbusGroup(PROP modbusId, AppDef<? super APP,? super PROP,? super PARAM> modbusIdDef, PROP modbusUnitId, AppDef<? super APP,? super PROP,? super PARAM> modbusUnitIdDef, PROP connectionModubsType)	Creates a AppDef group of a ComponentProps.pickModbusId() and a modbusUnitId() to check if the current selected modbus unit id already got selected.
static final AppDef<OpenemsApp,Nameable,Type.Parameter.BundleProvider>	modbusType()	Creates a AppDef for a ModbusType.
static final AppDef<OpenemsApp,Nameable,Type.Parameter.BundleProvider>	modbusUnitId()	Creates a AppDef for a modbusUnitId.
static final AppDef<OpenemsApp,Nameable,Type.Parameter.BundleProvider>	port()	Creates a AppDef for a port.

Methods inherited from class java.lang.Object

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

Method Details

modbusType

public static final AppDef<OpenemsApp,Nameable,Type.Parameter.BundleProvider> modbusType()

Creates a AppDef for a ModbusType.

Returns:

the AppDef

ip

public static final AppDef<OpenemsApp,Nameable,Type.Parameter.BundleProvider> ip()

Creates a AppDef for a ip-address.

Returns:

the AppDef

port

public static final AppDef<OpenemsApp,Nameable,Type.Parameter.BundleProvider> port()

Creates a AppDef for a port.

Returns:

the AppDef

modbusUnitId

public static final AppDef<OpenemsApp,Nameable,Type.Parameter.BundleProvider> modbusUnitId()

Creates a AppDef for a modbusUnitId.

Returns:

the AppDef

modbusGroup

public static final <APP extends OpenemsApp & ComponentManagerSupplier & ComponentUtilSupplier,
PROP extends Nameable,
PARAM extends Type.Parameter.BundleProvider>
AppDef<APP,PROP,PARAM> modbusGroup(PROP modbusId,
 AppDef<? super APP,? super PROP,? super PARAM> modbusIdDef,
 PROP modbusUnitId,
 AppDef<? super APP,? super PROP,? super PARAM> modbusUnitIdDef)

Creates a AppDef group of a ComponentProps.pickModbusId() and a modbusUnitId() to check if the current selected modbus unit id already got selected.

Type Parameters:

APP - the type of the app

PROP - the type of the properties

PARAM - the type of the parameters

Parameters:

modbusId - the Nameable of the modbus id

modbusIdDef - the AppDef of the modbus id

modbusUnitId - the Nameable of the modbus unit id

modbusUnitIdDef - the AppDef of the modbus unit id

Returns:

the AppDef

modbusGroup

public static final <APP extends OpenemsApp & ComponentManagerSupplier & ComponentUtilSupplier,
PROP extends Nameable,
PARAM extends Type.Parameter.BundleProvider>
AppDef<APP,PROP,PARAM> modbusGroup(PROP modbusId,
 AppDef<? super APP,? super PROP,? super PARAM> modbusIdDef,
 PROP modbusUnitId,
 AppDef<? super APP,? super PROP,? super PARAM> modbusUnitIdDef,
 PROP connectionModubsType)

Creates a AppDef group of a ComponentProps.pickModbusId() and a modbusUnitId() to check if the current selected modbus unit id already got selected.

Type Parameters:

APP - the type of the app

PROP - the type of the properties

PARAM - the type of the parameters

Parameters:

modbusId - the Nameable of the modbus id

modbusIdDef - the AppDef of the modbus id

modbusUnitId - the Nameable of the modbus unit id

modbusUnitIdDef - the AppDef of the modbus unit id

connectionModubsType - if set add a default value of 1 if ModbusType.TCP is selected

Returns:

the AppDef