Sidebar
actuator_iotactuator
Table of Contents
Actuator Layer (iotActuator)
The Actuator layer provides an emulated IoT actuator. It must be deployed on top of an HTTP, MQTT, UDP, IP, AWS, Azure or CoAP layer.
Actuator Layer Configuration Parameters
| Parameter | Type | Description |
|---|---|---|
| Actuator List | Number | List of Actuators |
| Alias | String | |
| Debug Log Level | Number | Debug Level |
| Dependencies | String | Other dependencies to this element |
| Destination Peer | Number | |
| Event Filter | String | Filter of Event |
| Exact Match | Boolean | |
| Max Event Queue Size | Number | Maximum Queue Size |
| Name | String | Component Name |
| No Events | Boolean | |
| Passthrough | Boolean | High-to-Low Layer Passthrough |
| Raw Data To Inject | String | Data Packet to Inject |
| Raw Dst L2 To Inject | String | Destination L2 Address |
| Raw Dst L3 To Inject | String | Destination L3 Address |
| Raw Dst L4 To Inject | String | Destination L4 Address |
| Request Timeout | Number | |
| Save Dynamic Config | Boolean | |
| Show Commands | Boolean | Show Commands |
| Show Events | Boolean | Show Events |
| Watch | Boolean | Watch Layer |
Actuator Layer Functions
| Function | Type | Description |
|---|---|---|
| getIotactuatorAllowBlockingEvent(layer) | getter | Get “Allow Blocking Event” Parameter |
| getIotactuatorBlocked(layer) | getter | Get “Blocked” Parameter |
| getIotactuatorDebugLogLevel(layer) | getter | Get “Debug Log Level” Parameter |
| getIotactuatorDestinationPeer(layer) | getter | Get “Destination Peer” Parameter |
| getIotactuatorEnableJSON(layer) | getter | Get “Enable JSON” Parameter |
| getIotactuatorList(layer) | getter | Get “List” Parameter |
| getIotactuatorMaxInstances(layer) | getter | Get “Max Instances” Parameter |
| getIotactuatorNoEvents(layer) | getter | Get “No Events” Parameter |
| getIotactuatorPassthrough(layer) | getter | Get “Passthrough” Parameter |
| getIotactuatorRefreshTimer(layer) | getter | Get “Refresh Timer” Parameter |
| getIotactuatorWatch(layer) | getter | Get “Watch” Parameter |
| getStatsIotactuatorAvailableInstances(layer) | getter | Get “Available Instances” Parameter |
| getStatsIotactuatorDownstreamLastPacket(layer) | getter | Get “Downstream Last Packet” Parameter |
| getStatsIotactuatorDownstreamPacketCount(layer) | getter | Get “Downstream Packet Count” Parameter |
| getStatsIotactuatorMaxDownstreamDelay(layer) | getter | Get “Max Downstream Delay” Parameter |
| getStatsIotactuatorMaxUpstreamDelay(layer) | getter | Get “Max Upstream Delay” Parameter |
| getStatsIotactuatorMeanDownstreamDelay(layer) | getter | Get “Mean Downstream Delay” Parameter |
| getStatsIotactuatorMeanUpstreamDelay(layer) | getter | Get “Mean Upstream Delay” Parameter |
| getStatsIotactuatorMinDownstreamDelay(layer) | getter | Get “Min Downstream Delay” Parameter |
| getStatsIotactuatorMinUpstreamDelay(layer) | getter | Get “Min Upstream Delay” Parameter |
| getStatsIotactuatorName(layer) | getter | Get “Name” Parameter |
| getStatsIotactuatorRateBpsDownstream(layer) | getter | Get “Rate Bps Downstream” Parameter |
| getStatsIotactuatorRateBpsUpstream(layer) | getter | Get “Rate Bps Upstream” Parameter |
| getStatsIotactuatorTimestampIn(layer) | getter | Get “Timestamp In” Parameter |
| getStatsIotactuatorTimestampOut(layer) | getter | Get “Timestamp Out” Parameter |
| getStatsIotactuatorType(layer) | getter | Get “Type” Parameter |
| getStatsIotactuatorUpstreamLastPacket(layer) | getter | Get “Upstream Last Packet” Parameter |
| getStatsIotactuatorUpstreamPacketCount(layer) | getter | Get “Upstream Packet Count” Parameter |
| getStatsIotactuatorVarianceDownstreamDelay(layer) | getter | Get “Variance Downstream Delay” Parameter |
| getStatsIotactuatorVarianceUpstreamDelay(layer) | getter | Get “Variance Upstream Delay” Parameter |
| iotActuatorAddUri(layer,uri,delta) | function | Add URI |
| iotActuatorClear(layer) | function | Clear |
| iotActuatorRemoveUri(layer,uri) | function | Remove URI |
| iotActuatorUpdate(layer) | function | Update |
| setIotactuatorAllowBlockingEvent(layer,value) | setter | Set “Allow Blocking Event” Parameter |
| setIotactuatorBlocked(layer,value) | setter | Set “Blocked” Parameter |
| setIotactuatorDebugLogLevel(layer,value) | setter | Set “Debug Log Level” Parameter |
| setIotactuatorEnableJSON(layer,value) | setter | Set “Enable JSON” Parameter |
| setIotactuatorList(layer,value) | setter | Set “List” Parameter |
| setIotactuatorNoEvents(layer,value) | setter | Set “No Events” Parameter |
| setIotactuatorPassthrough(layer,value) | setter | Set “Passthrough” Parameter |
| setIotactuatorRefreshTimer(layer,value) | setter | Set “Refresh Timer” Parameter |
| setIotactuatorWatch(layer,value) | setter | Set “Watch” Parameter |
Actuator Layer Functions
| Function | Type | Description |
|---|---|---|
| getStatsIotactuatorAvailableInstances(layer) | getter | Get “Available Instances” Parameter |
| getStatsIotactuatorDownstreamLastPacket(layer) | getter | Get “Downstream Last Packet” Parameter |
| getStatsIotactuatorDownstreamPacketCount(layer) | getter | Get “Downstream Packet Count” Parameter |
| getStatsIotactuatorMaxDownstreamDelay(layer) | getter | Get “Max Downstream Delay” Parameter |
| getStatsIotactuatorMaxUpstreamDelay(layer) | getter | Get “Max Upstream Delay” Parameter |
| getStatsIotactuatorMeanDownstreamDelay(layer) | getter | Get “Mean Downstream Delay” Parameter |
| getStatsIotactuatorMeanUpstreamDelay(layer) | getter | Get “Mean Upstream Delay” Parameter |
| getStatsIotactuatorMinDownstreamDelay(layer) | getter | Get “Min Downstream Delay” Parameter |
| getStatsIotactuatorMinUpstreamDelay(layer) | getter | Get “Min Upstream Delay” Parameter |
| getStatsIotactuatorName(layer) | getter | Get “Name” Parameter |
| getStatsIotactuatorRateBpsDownstream(layer) | getter | Get “Rate Bps Downstream” Parameter |
| getStatsIotactuatorRateBpsUpstream(layer) | getter | Get “Rate Bps Upstream” Parameter |
| getStatsIotactuatorTimestampIn(layer) | getter | Get “Timestamp In” Parameter |
| getStatsIotactuatorTimestampOut(layer) | getter | Get “Timestamp Out” Parameter |
| getStatsIotactuatorType(layer) | getter | Get “Type” Parameter |
| getStatsIotactuatorUpstreamLastPacket(layer) | getter | Get “Upstream Last Packet” Parameter |
| getStatsIotactuatorUpstreamPacketCount(layer) | getter | Get “Upstream Packet Count” Parameter |
| getStatsIotactuatorVarianceDownstreamDelay(layer) | getter | Get “Variance Downstream Delay” Parameter |
| getStatsIotactuatorVarianceUpstreamDelay(layer) | getter | Get “Variance Upstream Delay” Parameter |
| getiotactuatorAllowBlockingEvent(layer) | getter | Get “Allow Blocking Event” Parameter |
| getiotactuatorBlocked(layer) | getter | Get “Blocked” Parameter |
| getiotactuatorDebugLogLevel(layer) | getter | Get “Debug Log Level” Parameter |
| getiotactuatorDestinationPeer(layer) | getter | Get “Destination Peer” Parameter |
| getiotactuatorEnableJSON(layer) | getter | Get “Enable JSON” Parameter |
| getiotactuatorList(layer) | getter | Get “List” Parameter |
| getiotactuatorMaxInstances(layer) | getter | Get “Max Instances” Parameter |
| getiotactuatorNoEvents(layer) | getter | Get “No Events” Parameter |
| getiotactuatorPassthrough(layer) | getter | Get “Passthrough” Parameter |
| getiotactuatorRefreshTimer(layer) | getter | Get “Refresh Timer” Parameter |
| getiotactuatorWatch(layer) | getter | Get “Watch” Parameter |
| iotActuatorAddUri(layer,uri,delta) | function | Add URI |
| iotActuatorClear(layer) | function | Clear |
| iotActuatorRemoveUri(layer,uri) | function | Remove URI |
| iotActuatorUpdate(layer) | function | Update |
| setiotactuatorAllowBlockingEvent(layer,value) | setter | Set “Allow Blocking Event” Parameter |
| setiotactuatorBlocked(layer,value) | setter | Set “Blocked” Parameter |
| setiotactuatorDebugLogLevel(layer,value) | setter | Set “Debug Log Level” Parameter |
| setiotactuatorEnableJSON(layer,value) | setter | Set “Enable JSON” Parameter |
| setiotactuatorList(layer,value) | setter | Set “List” Parameter |
| setiotactuatorNoEvents(layer,value) | setter | Set “No Events” Parameter |
| setiotactuatorPassthrough(layer,value) | setter | Set “Passthrough” Parameter |
| setiotactuatorRefreshTimer(layer,value) | setter | Set “Refresh Timer” Parameter |
| setiotactuatorWatch(layer,value) | setter | Set “Watch” Parameter |
actuator_iotactuator.txt · Last modified: 2021/07/25 04:24 by vps