Inheritance diagram for BatterySocSensor:

Collaboration diagram for BatterySocSensor:

[legend]

Public Member Functions
	~BatterySocSensor ()

	BatterySocSensor (BatterySocSensor const &)=delete

void	operator= (BatterySocSensor const &)=delete

Public Member Functions inherited from SensorImpl
virtual	~SensorImpl ()

	SensorImpl (SensorImpl const &)=delete

	SensorImpl (SensorImpl &&)=delete

void	operator= (SensorImpl const &)=delete

void	operator= (SensorImpl &&)=delete

error::KallistoDetailedResult	registerListener (std::map< std::string, const void *> parameters, SensorEventListener &listener)

error::KallistoDetailedResult	unregisterListener (SensorEventListener &listener)

bool	getEnabled ()

void	onLinkLoss ()

error::KallistoDetailedResult	onLinkRecovered ()

Public Member Functions inherited from Sensor
unsigned int	getHandle () const

std::string	getName () const

std::string	getAddress () const

std::string	getVendor () const

unsigned int	getVersion () const

SensorType	getType () const

std::string	getStringType () const

ReportingMode	getReportingMode () const

unsigned int	getIdentifier () const

float	getMaximumRange () const

float	getResolution () const

float	getPower () const

std::chrono::microseconds	getMinDelay () const

std::chrono::microseconds	getMaxDelay () const

std::string	toString ()

bool	operator== (const Sensor &other) const

bool	operator!= (const Sensor &other) const

Static Public Member Functions
static bool	isAvailable (unsigned int identifier, const std::map< uint16_t, std::vector< uint8_t > > &manufacturer_data)

static bool	isAvailable (unsigned int identifier, bluetooth::BluetoothDispatcher &bluetooth_dispatcher)

static std::vector< std::unique_ptr< SensorImpl > >	build (std::string address, util::Executor &event_dispatcher, bluetooth::BluetoothDispatcher &bluetooth_dispatcher, const std::map< uint16_t, std::vector< uint8_t > > &manufacturer_data)

Static Public Member Functions inherited from SensorImpl
static unsigned int	generateHandle ()

static const std::string &	KEY_DELAY ()

static unsigned char	getTypeFromManufacturerData (unsigned char byte)

static unsigned char	getIdFromManufacturerData (unsigned char byte)

Static Public Member Functions inherited from Sensor
static unsigned int	getValueArraySize (SensorType type)

Protected Member Functions
	BatterySocSensor (std::string name, std::string address, std::string vendor, unsigned int version, SensorType type, std::string string_type, ReportingMode reporting_mode, unsigned int identifier, float max_range, float resolution, float power, std::chrono::microseconds min_delay, std::chrono::microseconds max_delay, util::Executor &event_dispatcher, bluetooth::BluetoothDispatcher &bluetooth_dispatcher)

error::KallistoDetailedResult	start (std::map< std::string, const void *> parameters, InternalSensorEventListener internal_listener)

error::KallistoDetailedResult	update (std::map< std::string, const void *> parameters)

std::map< std::string, const void * >	getParameters ()

error::KallistoDetailedResult	stop (bool link_loss)

void	onNotification (std::string address, std::string service_uuid, std::string characteristic_uuid, const std::vector< unsigned char > &values)

Protected Member Functions inherited from SensorImpl
	SensorImpl (std::string name, std::string address, std::string vendor, unsigned int version, SensorType type, std::string string_type, ReportingMode reporting_mode, unsigned int identifier, float max_range, float resolution, float power, std::chrono::microseconds min_delay, std::chrono::microseconds max_delay, util::Executor &event_dispatcher, bluetooth::BluetoothDispatcher &bluetooth_dispatcher, TimeSynchronizer *sensor_synchronizer)

Protected Member Functions inherited from Sensor
	Sensor (unsigned int handle, std::string name, std::string address, std::string vendor, unsigned int version, SensorType type, std::string string_type, ReportingMode reporting_mode, unsigned int identifier, float max_range, float resolution, float power, std::chrono::microseconds min_delay, std::chrono::microseconds max_delay)

virtual	~Sensor ()

	Sensor (Sensor const &)=delete

	Sensor (Sensor &&)=delete

void	operator= (Sensor const &)=delete

void	operator= (Sensor &&)=delete

Protected Member Functions inherited from BluetoothDispatcher::NotificationListener
	NotificationListener ()

virtual	~NotificationListener ()

	NotificationListener (NotificationListener const &)=delete

	NotificationListener (NotificationListener &&)=delete

void	operator= (NotificationListener const &)=delete

void	operator= (NotificationListener &&)=delete

Additional Inherited Members
Public Types inherited from Sensor
enum	SensorType { ACCELEROMETER, MAGNETIC_FIELD, GYROSCOPE, PRESSURE, RELATIVE_HUMIDITY, AMBIENT_TEMPERATURE, BATTERY_SOC, BATTERY_CHARGING_STATUS, RSSI, ANALOG, CO2_CONCENTRATION, TVOC_CONCENTRATION }

enum	ReportingMode { REPORTING_MODE_CONTINUOUS, REPORTING_MODE_ON_CHANGE, REPORTING_MODE_ONE_SHOT, REPORTING_MODE_SPECIAL_TRIGGER }

Protected Attributes inherited from SensorImpl
bool	m_link_loss

bluetooth::BluetoothDispatcher &	m_bluetooth_dispatcher

TimeSynchronizer *	m_sensor_synchronizer

Protected Attributes inherited from Sensor
const unsigned int	m_handle

const std::string	m_name

const std::string	m_address

const std::string	m_vendor

const unsigned int	m_version

const SensorType	m_type

const std::string	m_string_type

const ReportingMode	m_reporting_mode

const unsigned int	m_identifier

const float	m_max_range

const float	m_resolution

const float	m_power

const std::chrono::microseconds	m_min_delay

const std::chrono::microseconds	m_max_delay

Constructor & Destructor Documentation

◆ BatterySocSensor() [1/2]

BatterySocSensor	(	std::string	name,
		std::string	address,
		std::string	vendor,
		unsigned int	version,
		SensorType	type,
		std::string	string_type,
		ReportingMode	reporting_mode,
		unsigned int	identifier,
		float	max_range,
		float	resolution,
		float	power,
		std::chrono::microseconds	min_delay,
		std::chrono::microseconds	max_delay,
		util::Executor &	event_dispatcher,
		bluetooth::BluetoothDispatcher &	bluetooth_dispatcher
	)

protected

Constructor.

◆ ~BatterySocSensor()

~BatterySocSensor ( )

Destructor.

◆ BatterySocSensor() [2/2]

BatterySocSensor ( BatterySocSensor const & )

delete

Remove copy.

Member Function Documentation

◆ build()

static std::vector<std::unique_ptr<SensorImpl> > build	(	std::string	address,
		util::Executor &	event_dispatcher,
		bluetooth::BluetoothDispatcher &	bluetooth_dispatcher,
		const std::map< uint16_t, std::vector< uint8_t > > &	manufacturer_data
	)

static

Builds the instances of the Battery State-of-Charge (SoC) sensor that exist in the device.

Parameters

address	The MAC address of the device under discovery.
event_dispatcher	Sensor event dispatcher.
bluetooth_dispatcher	BLE operations dispatcher.
manufacturer_data	The advertised manufacturer data of the device. Each key represents an company ID and each value is a byte array of the service data.

Returns: A list of Sensors.

◆ getParameters()

std::map<std::string, const void*> getParameters ( )

protectedvirtual

Get the current configured parameters.

Returns: The current configured parameter map.

Implements SensorImpl.

◆ isAvailable() [1/2]

static bool isAvailable	(	unsigned int	identifier,
		const std::map< uint16_t, std::vector< uint8_t > > &	manufacturer_data
	)

static

Checks if the Battery State-of-Charge (SoC) sensor is available using the manufacturer data.

Parameters

identifier	Instance of the battery SoC sensor.
manufacturer_data	The advertised manufacturer data of the device. Each key represents an company ID and each value is a byte array of the service data.

Returns: True if the Accelerometer is present and enabled in the device.

◆ isAvailable() [2/2]

static bool isAvailable	(	unsigned int	identifier,
		bluetooth::BluetoothDispatcher &	bluetooth_dispatcher
	)

static

Checks if the Battery State-of-Charge (SoC) sensor is available using characteristic data. Note: If legacy discovery is not enabled, the service list will be empty so no device will be discovered.

Parameters

identifier	Instance of the battery SoC sensor.
bluetooth_dispatcher	BLE operations dispatcher.

Returns: True if the Accelerometer is present and enabled in the device.

◆ onNotification()

void onNotification	(	std::string	address,
		std::string	service_uuid,
		std::string	characteristic_uuid,
		const std::vector< unsigned char > &	values
	)

protectedvirtual

Called when there is a new notification of a characteristic.

Parameters

address	The mac address of the device that generated this event.
serviceUuid	The UUID of the service that contains the characteristic that generated this event.
characteristicUuid	The UUID of the characteristic that generated this event.
values	A byte buffer with the new values of the characteristics.

Implements BluetoothDispatcher::NotificationListener.

◆ operator=()

void operator= ( BatterySocSensor const & )

delete

Remove attribution.

◆ start()

error::KallistoDetailedResult start	(	std::map< std::string, const void *>	parameters,
		InternalSensorEventListener	internal_listener
	)

protectedvirtual

Called when the sensor should be enabled and start reporting data.

See also: registerListener for parameter informations.

Parameters

parameters	Map of abstract parameters. The map follows a key/value structure where the key determines how the object should be parsed.
internal_listener	All sensor events should be sent to this listener.

Returns: A detailed result.

Implements SensorImpl.

◆ stop()

error::KallistoDetailedResult stop ( bool link_loss )

protectedvirtual

Called when the sensor should be disabled and stop reporting data.

Parameters

link_loss True if the device is in link loss and there is no BLE connection. Should only clear data in this case. If it is false, BLE communication can be conducted to disable the sensor in the peripheral side.

Returns: A detailed result.

Implements SensorImpl.

◆ update()

error::KallistoDetailedResult update ( std::map< std::string, const void *> parameters )

protectedvirtual

Called when when the sensor is already enabled and should update its' configurations.

See also: registerListener for parameter informations.

Parameters

parameters Map of abstract parameters. The map follows a key/value structure where the key determines how the object should be parsed.

Returns: A detailed result.

Implements SensorImpl.

The documentation for this class was generated from the following file:

/home/joao.oliveira/Workspace/local/repo/documentation/sphinx/source/components/kallistolinuxapi/include/hardware/hal/sensors/generic/battery_soc_sensor.hpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ BatterySocSensor() [1/2]

◆ ~BatterySocSensor()

◆ BatterySocSensor() [2/2]

Member Function Documentation

◆ build()

◆ getParameters()

◆ isAvailable() [1/2]

◆ isAvailable() [2/2]

◆ onNotification()

◆ operator=()

◆ start()

◆ stop()

◆ update()