Package io.openems.edge.controller.api.mqtt

Class ControllerApiMqttImpl

java.lang.Object

io.openems.edge.common.component.AbstractOpenemsComponent

io.openems.edge.controller.api.mqtt.ControllerApiMqttImpl

All Implemented Interfaces:

OpenemsComponent, Controller, ControllerApiMqtt, org.osgi.service.event.EventHandler

public class ControllerApiMqttImpl
extends AbstractOpenemsComponent
implements ControllerApiMqtt, Controller, OpenemsComponent, org.osgi.service.event.EventHandler

Nested Class Summary

Nested classes/interfaces inherited from interface io.openems.edge.controller.api.Controller

Controller.ChannelId

Nested classes/interfaces inherited from interface io.openems.edge.controller.api.mqtt.ControllerApiMqtt

ControllerApiMqtt.ChannelId

Nested classes/interfaces inherited from interface io.openems.edge.common.component.OpenemsComponent

OpenemsComponent.ChannelId

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	COMPONENT_NAME
protected ComponentManager	componentManager
protected io.openems.edge.controller.api.mqtt.Config	config

Fields inherited from interface io.openems.edge.controller.api.mqtt.ControllerApiMqtt

TOPIC_CHANNEL_LAST_UPDATE, TOPIC_CHANNEL_PREFIX, TOPIC_EDGE_CONFIG

Constructor Summary

Constructors

Constructor	Description
ControllerApiMqttImpl()

Method Summary

Modifier and Type	Method	Description
protected static String	createTopicPrefix(io.openems.edge.controller.api.mqtt.Config config)	Creates the topic prefix in either format.
protected void	deactivate()	Handles @Deactivate of implementations.
void	handleEvent(org.osgi.service.event.Event event)
protected void	logInfo(org.slf4j.Logger log, String message)	Log an info message including the Component ID.
protected void	logWarn(org.slf4j.Logger log, String message)	Log a warn message including the Component ID.
protected boolean	publish(String subTopic, String message, int qos, boolean retained, org.eclipse.paho.mqttv5.common.packet.MqttProperties properties)	Publish a message to a topic.
protected boolean	publish(String subTopic, org.eclipse.paho.mqttv5.common.MqttMessage message)	Publish a message to a topic.
void	run()	Executes the Controller logic.

Methods inherited from class io.openems.edge.common.component.AbstractOpenemsComponent

_channel, activate, activate, addChannel, addChannels, addChannels, alias, channels, getComponentContext, id, isEnabled, logDebug, logError, modified, removeChannel

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.openems.edge.controller.api.Controller

_setRunFailed, getRunFailed, getRunFailedChannel

Methods inherited from interface io.openems.edge.common.component.OpenemsComponent

_channel, _getChannelAs, alias, channel, channel, channels, debugLog, getComponentContext, getState, getStateChannel, hasFaults, id, isEnabled, serviceFactoryPid, servicePid

Field Details

COMPONENT_NAME

protected static final String COMPONENT_NAME

See Also:

• Constant Field Values

componentManager

protected ComponentManager componentManager

config

protected io.openems.edge.controller.api.mqtt.Config config

Constructor Details

ControllerApiMqttImpl

public ControllerApiMqttImpl()

Method Details

createTopicPrefix

protected static String createTopicPrefix(io.openems.edge.controller.api.mqtt.Config config)

Creates the topic prefix in either format.

• topic_prefix/edge/edge_id/
• edge/edge_id/

Parameters:

config - the Config

Returns:

the prefix

deactivate

protected void deactivate()

Description copied from class: AbstractOpenemsComponent

Handles @Deactivate of implementations. Prints log output.

Overrides:

deactivate in class AbstractOpenemsComponent

run

public void run()
         throws OpenemsError.OpenemsNamedException

Description copied from interface: Controller

Executes the Controller logic.

Specified by:

run in interface Controller

Throws:

OpenemsError.OpenemsNamedException - on error

logInfo

protected void logInfo(org.slf4j.Logger log,
 String message)

Description copied from class: AbstractOpenemsComponent

Log an info message including the Component ID.

Overrides:

logInfo in class AbstractOpenemsComponent

Parameters:

log - the Logger instance

message - the message

logWarn

protected void logWarn(org.slf4j.Logger log,
 String message)

Description copied from class: AbstractOpenemsComponent

Log a warn message including the Component ID.

Overrides:

logWarn in class AbstractOpenemsComponent

Parameters:

log - the Logger instance

message - the message

handleEvent

public void handleEvent(org.osgi.service.event.Event event)

Specified by:

handleEvent in interface org.osgi.service.event.EventHandler

publish

protected boolean publish(String subTopic,
 org.eclipse.paho.mqttv5.common.MqttMessage message)

Publish a message to a topic.

Parameters:

subTopic - the MQTT topic. The global MQTT Topic prefix is added in front of this string

message - the message

Returns:

true if message was successfully published; false otherwise

publish

protected boolean publish(String subTopic,
 String message,
 int qos,
 boolean retained,
 org.eclipse.paho.mqttv5.common.packet.MqttProperties properties)

Publish a message to a topic.

Parameters:

subTopic - the MQTT topic. The global MQTT Topic prefix is added in front of this string

message - the message; internally translated to a UTF-8 byte array

qos - the MQTT QOS

retained - the MQTT retained parameter

properties - the MqttProperties

Returns:

true if message was successfully published; false otherwise