bibliothek

Summary

Members	Descriptions
defineSENSORTYPE
enumStatus
classBrightnessSensor
classEmptyEEPROM
classEmptyTestRadioDevice
classPullUpSetupButtonDevice
classRadioDevice
classSensorBoardDevice
classSensorDevice
classSetupButtonDevice
classSingleLedStatusDevice
classStatusDevice
classStm32EEPROM
classSTM32SensorBoard
classStorageDevice

Members

defineSENSORTYPE

enumStatus

Values	Descriptions
OK
SETUP_MODE
LINKING
ERROR
SEND_MQTT_MESSAGE
EMPTY

class BrightnessSensor

class BrightnessSensor
  : public SensorDevice

Summary

Members	Descriptions
public virtual boolbegin()	Initialization of the sensor and determination of the output-mode.
public virtual boolloop()	Is called for every run.
public virtual JsonObject &getValueToSendAsJson(DynamicJsonBuffer & buffer)	Returns the current value of the sensor as Json-object.
public virtual JsonArray &getTypeAsJson(DynamicJsonBuffer & buffer)	Returns the type of the sensor as Json-object.

Members

public virtual boolbegin()

Initialization of the sensor and determination of the output-mode.

Parameters

• TRUE Successful initialization

• FALSE Sensor could not be initialized

public virtual boolloop()

Is called for every run.

public virtual JsonObject &getValueToSendAsJson(DynamicJsonBuffer & buffer)

Returns the current value of the sensor as Json-object.

Returns

Current value as Json-object

public virtual JsonArray &getTypeAsJson(DynamicJsonBuffer & buffer)

Returns the type of the sensor as Json-object.

Returns

Type as Json-object

class EmptyEEPROM

class EmptyEEPROM
  : public StorageDevice

Summary

Members	Descriptions
public virtual StringreadFromStorage(String key)	Returns the value to the associated key from memory.
public virtual boolwriteInStorage(String key,String value)	Permanently saves the value with the associated key in memory.
public virtual boolremoveFromStorage(String key)	Removes the value from the memory.

Members

public virtual StringreadFromStorage(String key)

Returns the value to the associated key from memory.

Parameters

• key key of the value

Returns

value

public virtual boolwriteInStorage(String key,String value)

Permanently saves the value with the associated key in memory.

Parameters

• TRUE Value saved successfully

• FALSE Value could't be saved

public virtual boolremoveFromStorage(String key)

Removes the value from the memory.

Parameters

• TRUE Value removed successfully

• FALSE Value could't be removed

class EmptyTestRadioDevice

class EmptyTestRadioDevice
  : public RadioDevice

Summary

Members	Descriptions
publicEmptyTestRadioDevice()
public virtual boolbegin()	Initialization of radio module.
public virtual boolloop()	Is called for every run.
public virtual boolstartRadioDevice()	Radio module is started.
public virtual boolstopRadioDevice()	Radio module is stopped.
public virtual intgetMaxMessageLength()	Returns the maximum length of the messages that can be sent by the radio module.
public virtual JsonVariantgetTypeAsJson(DynamicJsonBuffer & buffer)	Returns the type of the radio module as Json-object.
public virtual JsonObject &getConfigAsJson(DynamicJsonBuffer & buffer)	Returns the configuration of the radio module as Json-object.
public virtual voidsetServerConfig(JsonObject & jsonConfig)	Sets the configuration of the radio module.
public virtual boolsendMessage(String & buffer)	Sends the message to the server.
public virtual boolconnect()	The connection to the server is being established.

Members

publicEmptyTestRadioDevice()

public virtual boolbegin()

Initialization of radio module.

Parameters

• TRUE Successful initialization

• FALSE Radio module could not be initialized

public virtual boolloop()

Is called for every run.

public virtual boolstartRadioDevice()

Radio module is started.

Parameters

• TRUE Successful start

• FALSE Radio module could not be started

public virtual boolstopRadioDevice()

Radio module is stopped.

Parameters

• TRUE Successful Stop

• FALSE Radio module could not be stopped

public virtual intgetMaxMessageLength()

Returns the maximum length of the messages that can be sent by the radio module.

Returns

maximum message-length

public virtual JsonVariantgetTypeAsJson(DynamicJsonBuffer & buffer)

Returns the type of the radio module as Json-object.

Returns

type as Json-object

public virtual JsonObject &getConfigAsJson(DynamicJsonBuffer & buffer)

Returns the configuration of the radio module as Json-object.

Returns

configuration as Json-object

public virtual voidsetServerConfig(JsonObject & jsonConfig)

Sets the configuration of the radio module.

Parameters

• jsonConfig configuration of the radio module

public virtual boolsendMessage(String & buffer)

Sends the message to the server.

Parameters

• buffer the sending message

Parameters

• TRUE Message sent successfully

• FALSE Message could not be sent

public virtual boolconnect()

The connection to the server is being established.

Parameters

• TRUE Connection is established successfully

• FALSE Connection could not be established

class PullUpSetupButtonDevice

class PullUpSetupButtonDevice
  : public SetupButtonDevice

Summary

Members	Descriptions
publicPullUpSetupButtonDevice(int buttonPin)
public virtual boolbegin()	Initialization of the button and determination of the input-mode for the button.
public virtual boolloop()	Is called for every run.
public virtual boolisPressed()	Returns, if the button is pressed.

Members

publicPullUpSetupButtonDevice(int buttonPin)

public virtual boolbegin()

Initialization of the button and determination of the input-mode for the button.

Parameters

• TRUE Initialization successful

• FALSE Button could not be initialized

public virtual boolloop()

Is called for every run.

public virtual boolisPressed()

Returns, if the button is pressed.

Parameters

• TRUE Button is pressed

• FALSE Button is not pressed

class RadioDevice

Summary

Members	Descriptions
public boolbegin()	Initialization of radio module.
public boolloop()	Is called for every run.
public boolstartRadioDevice()	Radio module is started.
public boolstopRadioDevice()	Radio module is stopped.
public intgetMaxMessageLength()	Returns the maximum length of the messages that can be sent by the radio module.
public JsonVariantgetTypeAsJson(DynamicJsonBuffer & buffer)	Returns the type of the radio module as Json-object.
public JsonObject &getConfigAsJson(DynamicJsonBuffer & buffer)	Returns the configuration of the radio module as Json-object.
public voidsetServerConfig(JsonObject & jsonConfig)	Sets the configuration of the radio module.
public boolsendMessage(String & buffer)	Sends the message to the server.
public boolconnect()	The connection to the server is being established.

Members

public boolbegin()

Initialization of radio module.

Parameters

• TRUE Successful initialization

• FALSE Radio module could not be initialized

public boolloop()

Is called for every run.

public boolstartRadioDevice()

Radio module is started.

Parameters

• TRUE Successful start

• FALSE Radio module could not be started

public boolstopRadioDevice()

Radio module is stopped.

Parameters

• TRUE Successful Stop

• FALSE Radio module could not be stopped

public intgetMaxMessageLength()

Returns the maximum length of the messages that can be sent by the radio module.

Returns

maximum message-length

public JsonVariantgetTypeAsJson(DynamicJsonBuffer & buffer)

Returns the type of the radio module as Json-object.

Returns

type as Json-object

public JsonObject &getConfigAsJson(DynamicJsonBuffer & buffer)

Returns the configuration of the radio module as Json-object.

Returns

configuration as Json-object

public voidsetServerConfig(JsonObject & jsonConfig)

Sets the configuration of the radio module.

Parameters

• jsonConfig configuration of the radio module

public boolsendMessage(String & buffer)

Sends the message to the server.

Parameters

• buffer the sending message

Parameters

• TRUE Message sent successfully

• FALSE Message could not be sent

public boolconnect()

The connection to the server is being established.

Parameters

• TRUE Connection is established successfully

• FALSE Connection could not be established

class SensorBoardDevice

Summary

Members	Descriptions
publicSensorBoardDevice()
public~SensorBoardDevice()
public boolbegin()	Initialization of the sensor-board.
public boolloop()	This method is run through in every loop in the ino-file.
public boolsendMessage(String & buffer)	Sending a message via the radio-module.
publicStatusDevice&getStatus()	Returns the device for the output of the status.
public voidsetStatus(StatusDevice& status)	Sets the device for the output of the status.
publicSetupButtonDevice&getSetupButton()	Returns the button that starts the setup-mode.
public voidsetSetupButton(SetupButtonDevice& setupButton)	Sets the button that starts the setup-mode.
publicRadioDevice&getRadioModul()	Returns the radio-module that is used for the connection to the bridge.
public voidsetRadioModul(RadioDevice& radioModul)	Sets the radio-module that is used for the connection to the bridge.
publicSensorDevice&getSensor()	Returns the sensor that is installed on the sensor-board.
public voidsetSensor(SensorDevice& sensor)	Sets the sensor that is installed on the sensor-board.
publicStorageDevice&getStorageDevice()	Returns the memory, which stored the data permanently.
public voidsetStorageDevice(StorageDevice& storage)	Sets the memory, which stored the data permanently.
public Stream &getConnectionStream()	Returns the http-connection that is used for the connection to the gateway.
public voidsetConnectionStream(Stream * stream)	Sets the http-connection that is used for the connection to the gateway.
public intgetSetupModePressTime()	Returns the amount of seconds that the button needs to be pressed to enter the setup-mode.
public voidsetSetupModePressTime(int pressTime)	Sets the amount of seconds that the button needs to be pressed to enter the setup-mode. Therefore the time for the setup-mode needs to be shorter than the time for the reset-mode.
public intgetResetPressTime()	Returns the amount of seconds that the button needs to be pressed to enter the reset-mode.
public voidsetResetPressTime(int pressTime)	Sets the amount of seconds that the button needs to be pressed to enter the reset-mode. Therefore the time for the reset-mode needs to be longer than the time for the setup-mode.
public char *getUuid()	Returns the UUID of the device.
public voidsetUuid(const char * uuid)	Sets the UUID of the device.
public boolisInSetupMode()	Indicating if the sensor-board is in setup-mode.
public JsonObject &getContextAsJson(JsonBuffer & buffer)	Returns the JsonLD-context of the Sensor-Board.

Members

publicSensorBoardDevice()

public~SensorBoardDevice()

public boolbegin()

Initialization of the sensor-board.

Parameters

• TRUE Successful initialization

• FALSE Sensor-Board could not be initialized

public boolloop()

This method is run through in every loop in the ino-file.

Parameters

• TRUE Method ran through successfully

• FALSE Method failed to run through

public boolsendMessage(String & buffer)

Sending a message via the radio-module.

Parameters

• buffer The message to be sent

Parameters

• TRUE Message was sent successfully

• FALSE Message could not be sent

publicStatusDevice&getStatus()

Returns the device for the output of the status.

Returns

statusDevice

public voidsetStatus(StatusDevice& status)

Sets the device for the output of the status.

Parameters

• status StatusDevice to be set

publicSetupButtonDevice&getSetupButton()

Returns the button that starts the setup-mode.

Returns

setupButton

public voidsetSetupButton(SetupButtonDevice& setupButton)

Sets the button that starts the setup-mode.

Parameters

• setupButton SetupButton to be set

publicRadioDevice&getRadioModul()

Returns the radio-module that is used for the connection to the bridge.

Returns

radioModul

public voidsetRadioModul(RadioDevice& radioModul)

Sets the radio-module that is used for the connection to the bridge.

Parameters

• radioModul Radio-module to be set

publicSensorDevice&getSensor()

Returns the sensor that is installed on the sensor-board.

Returns

sensor

public voidsetSensor(SensorDevice& sensor)

Sets the sensor that is installed on the sensor-board.

Parameters

• sensor Sensor to be set

publicStorageDevice&getStorageDevice()

Returns the memory, which stored the data permanently.

Returns

storage

public voidsetStorageDevice(StorageDevice& storage)

Sets the memory, which stored the data permanently.

Parameters

• storage to be set

public Stream &getConnectionStream()

Returns the http-connection that is used for the connection to the gateway.

Returns

connection

public voidsetConnectionStream(Stream * stream)

Sets the http-connection that is used for the connection to the gateway.

Parameters

• connection HttpConnection to be set

public intgetSetupModePressTime()

Returns the amount of seconds that the button needs to be pressed to enter the setup-mode.

Returns

Time in seconds

public voidsetSetupModePressTime(int pressTime)

Sets the amount of seconds that the button needs to be pressed to enter the setup-mode. Therefore the time for the setup-mode needs to be shorter than the time for the reset-mode.

Parameters

• pressTime Time in seconds

public intgetResetPressTime()

Returns the amount of seconds that the button needs to be pressed to enter the reset-mode.

Returns

Time in seconds

public voidsetResetPressTime(int pressTime)

Sets the amount of seconds that the button needs to be pressed to enter the reset-mode. Therefore the time for the reset-mode needs to be longer than the time for the setup-mode.

Parameters

• pressTime Time in seconds

public char *getUuid()

Returns the UUID of the device.

Returns

uuid

public voidsetUuid(const char * uuid)

Sets the UUID of the device.

Parameters

• uuid UUID to be set

public boolisInSetupMode()

Indicating if the sensor-board is in setup-mode.

Parameters

• TRUE Sensor-Board is in setup-mode

• FALSE Sensor-Board is not in setup-mode

public JsonObject &getContextAsJson(JsonBuffer & buffer)

Returns the JsonLD-context of the Sensor-Board.

Returns

context as JsonObject

class SensorDevice

Summary

Members	Descriptions
public boolbegin()	Initialization of the sensor and determination of the output-mode.
public boolloop()	Is called for every run.
public JsonObject &getValueToSendAsJson(DynamicJsonBuffer & buffer)	Returns the current value of the sensor as Json-object.
public JsonArray &getTypeAsJson(DynamicJsonBuffer & buffer)	Returns the type of the sensor as Json-object.

Members

public boolbegin()

Initialization of the sensor and determination of the output-mode.

Parameters

• TRUE Successful initialization

• FALSE Sensor could not be initialized

public boolloop()

Is called for every run.

public JsonObject &getValueToSendAsJson(DynamicJsonBuffer & buffer)

Returns the current value of the sensor as Json-object.

Returns

Current value as Json-object

public JsonArray &getTypeAsJson(DynamicJsonBuffer & buffer)

Returns the type of the sensor as Json-object.

Returns

Type as Json-object

class SetupButtonDevice

Summary

Members	Descriptions
public boolbegin()	Initialization of the button and determination of the input-mode for the button.
public boolloop()	Is called for every run.
public boolisPressed()	Returns, if the button is pressed.

Members

public boolbegin()

Initialization of the button and determination of the input-mode for the button.

Parameters

• TRUE Initialization successful

• FALSE Button could not be initialized

public boolloop()

Is called for every run.

public boolisPressed()

Returns, if the button is pressed.

Parameters

• TRUE Button is pressed

• FALSE Button is not pressed

class SingleLedStatusDevice

class SingleLedStatusDevice
  : public StatusDevice

Summary

Members	Descriptions
publicSingleLedStatusDevice(int ledPin)
public virtual boolbegin()	Initialization of the status and definition of the output-mode.
public virtual boolloop()	Is called in every turn and returns the current status.

Members

publicSingleLedStatusDevice(int ledPin)

public virtual boolbegin()

Initialization of the status and definition of the output-mode.

Parameters

• TRUE Successful initialization

• FALSE Status could not be initialized

public virtual boolloop()

Is called in every turn and returns the current status.

class StatusDevice

Summary

Members	Descriptions
publicStatus`[currentStatus`](#class_status_device_1a3a3ff51f5f629f02ed733b818ae84707)
public boolbegin()	Initialization of the status and definition of the output-mode.
public boolloop()	Is called in every turn and returns the current status.
public voidsetStatus(Statusstatus)	Sets the status.

Members

publicStatus`[currentStatus`](#class_status_device_1a3a3ff51f5f629f02ed733b818ae84707)

public boolbegin()

Initialization of the status and definition of the output-mode.

Parameters

• TRUE Successful initialization

• FALSE Status could not be initialized

public boolloop()

Is called in every turn and returns the current status.

public voidsetStatus(Statusstatus)

Sets the status.

Parameters

• status -> the status to be set

class Stm32EEPROM

class Stm32EEPROM
  : public StorageDevice

Summary

Members	Descriptions
public virtual StringreadFromStorage(String key)	Returns the value to the associated key from memory.
public virtual boolwriteInStorage(String key,String value)	Permanently saves the value with the associated key in memory.
public virtual boolremoveFromStorage(String key)	Removes the value from the memory.

Members

public virtual StringreadFromStorage(String key)

Returns the value to the associated key from memory.

Parameters

• key key of the value

Returns

value

public virtual boolwriteInStorage(String key,String value)

Permanently saves the value with the associated key in memory.

Parameters

• TRUE Value saved successfully

• FALSE Value could't be saved

public virtual boolremoveFromStorage(String key)

Removes the value from the memory.

Parameters

• TRUE Value removed successfully

• FALSE Value could't be removed

class STM32SensorBoard

class STM32SensorBoard
  : public SensorBoardDevice

Summary

Members	Descriptions

Members

class StorageDevice

Summary

Members	Descriptions
public StringreadFromStorage(String key)	Returns the value to the associated key from memory.
public boolwriteInStorage(String key,String value)	Permanently saves the value with the associated key in memory.
public boolremoveFromStorage(String key)	Removes the value from the memory.

Members

public StringreadFromStorage(String key)

Returns the value to the associated key from memory.

Parameters

• key key of the value

Returns

value

public boolwriteInStorage(String key,String value)

Permanently saves the value with the associated key in memory.

Parameters

• TRUE Value saved successfully

• FALSE Value could't be saved

public boolremoveFromStorage(String key)

Removes the value from the memory.

Parameters

• TRUE Value removed successfully

• FALSE Value could't be removed

Generated by Moxygen