Program scope. More...

Namespaces
namespace	logic
	Handle the main high level logics.

namespace	modes
	Contains basic interface types to implement custom user modes.

namespace	physical
	Handle the physical modules drivers.

namespace	platform
	Handle the platform specific interactions.

namespace	user
	Contains code handling custom user mode functions for indexable strips.

namespace	utils
	Utility function and classes.

Classes
class	CEveryNMillis
	define time routines More...

union	COLOR
	Use this to convert color to bytes. More...

Typedefs
using	byte = uint8_t

using	brightness_t = uint16_t
	Define the type of the brightness parameters.

Functions
void	secondary_thread ()

void	check_loop_runtime (const uint32_t runTime)

void	main_setup ()
	Setup of the program, call once on systel start.

void	regulate_loop_runtime (const uint32_t addedDelay)

void	main_loop (const uint32_t addedDelay)
	Run the main program loop.

bool	is_cell_voltage_valid (const uint16_t cellVoltage_mv)
	check battery cell voltage against min/max limits

template<typename N >
static constexpr N	min (const N a, const N b)
	Minimum of two numbers.

template<typename N >
static constexpr N	max (const N a, const N b)
	Maximum of two numbers.

template<typename N >
static constexpr N	abs (const N a)
	absolute of a number

template<typename T >
static constexpr T	lmpd_constrain (const T &a, const T &mini, const T &maxi)
	Constrain a number between two numbers.

template<typename T = float>
static T	lmpd_map (float x, const float in_min, const float in_max, const float out_min, const float out_max)
	Linearly interpolate a number between two numbers.

static constexpr float	to_radians (float degrees)
	Convert an angle in degrees to an angle in radians.

static constexpr float	wrap_angle (const float angle_rad)
	Wrap an angle in radians between 0 and 2*PI.

Variables
static constexpr size_t	stripNbBuffers = 3

static constexpr float	baseCurrentConsumption = 0.4f

static constexpr float	maxCurrentConsumption = 2.7f - baseCurrentConsumption

static constexpr float	ampPerLed = maxCurrentConsumption / (float)LED_COUNT

static constexpr uint8_t	BASE_SOFTWARE_VERSION_MAJOR = 1
	Base major software version, common to all systems. increment for every release.

static constexpr uint8_t	BASE_SOFTWARE_VERSION_MINOR = 8
	Base minor software version, common to all systems. increment for every release.

static constexpr uint8_t	ADC_RES_EXP = 12
	resolution of the ADC, in bits (can be 8, 10, 12 or 14)

static const uint32_t	ADC_MAX_VALUE = static_cast<uint32_t>(pow(2, ADC_RES_EXP))
	corresponding ADC max value

static constexpr float	internalReferenceVoltage = 3.0f
	internal voltage reference

static constexpr uint8_t	batteryCount = 3
	number of batteries for this model

static constexpr float	imuToCircuitRotationX_rad = 0.0f * c_degreesToRadians

static constexpr float	imuToCircuitRotationY_rad = 0.0f * c_degreesToRadians

static constexpr float	imuToCircuitRotationZ_rad = -9.0f * c_degreesToRadians

static constexpr float	imuToCircuitPositionX_m = 8.915f / 1000.0f

static constexpr float	imuToCircuitPositionY_m = -5.769f / 1000.0f

static constexpr float	imuToCircuitPositionZ_m = 0.0f / 1000.0f

static constexpr float	batteryChargeC_Rate = 0.33f
	Maximum charge rate.

static constexpr float	batteryDischargeC_Rate = 1.0f
	Typical discharge rate.

static constexpr uint32_t	batteryCapacity_mAH = 4850
	Battery capacity, in mA*hours.

static constexpr uint16_t	minLiionVoltage_mV = 2500
	minimum Li-ion voltage

static constexpr uint16_t	typicalLiionVoltage_mV = 3630
	standard 50% charge Li-ion voltage

static constexpr uint16_t	maxLiionVoltage_mV = 4200
	Absolute maximum allowed Li-ion voltage.

static constexpr uint16_t	minSafeLiionVoltage_mV = 3100
	minimum allowed li-ion voltage safe zone

static constexpr uint16_t	maxSafeLiionVoltage_mV = 4100
	maximum allowed li-ion voltage safe zone

static constexpr uint16_t	minSingularBatteryVoltage_mV
	with added margins to avoid wrong detection

static constexpr uint16_t	maxSingularBatteryVoltage_mV
	with added margins to avoid wrong detection

static constexpr float	maxSystemTemp_c = 70.0f
	maximum microcontroler temperature, in degrees

static constexpr float	criticalSystemTemp_c = 80.0f
	absolute maximum microcontroler temperature, in degrees

static constexpr uint16_t	batteryCritical = 300
	in % *100, critical battery level

static constexpr uint16_t	batteryLow = 500
	in % *100, low battery level

static constexpr uint8_t	USER_WATCHDOG_ID = 0
	user thread watchdog

static constexpr uint8_t	POWER_WATCHDOG_ID = 2
	power thread watchdog

static constexpr float	loopDeltaTime = MAIN_LOOP_UPDATE_PERIOD_MS / 1000.0f
	EXPECTED delta time for each loop run.

static constexpr uint16_t	batteryMaxVoltage_mV = maxLiionVoltage_mV * batteryCount
	max voltage of a single li-ion cell

static constexpr uint16_t	batteryMaxVoltageSafe_mV = maxSafeLiionVoltage_mV * batteryCount
	max voltage of a li-ion cell to maximise lifetime

static constexpr uint16_t	batteryTypicalVoltageSafe_mV = typicalLiionVoltage_mV * batteryCount
	typical pack voltage

static constexpr uint16_t	batteryMinVoltage_mV = minLiionVoltage_mV * batteryCount
	min voltage of a single li-ion cell

static constexpr uint16_t	batteryMinVoltageSafe_mV = minSafeLiionVoltage_mV * batteryCount
	min voltage of a li-ion cell to maximise lifetime

static constexpr float	totalCons_Watt = consWattByMeter * ledStripLength_mm / 1000.0f
	Total maximum power usage of the led strip.

static constexpr float	maxStripConsumption_A = 1000.0f * totalCons_Watt / stripInputMaxVoltage_mV
	Maximum led strip current usage, in Amps.

static constexpr uint32_t	batteryMaxChargeCurrent_mA
	Battery maximum charge current, in milliAmps.

static constexpr uint32_t	batteryMaxDischargeCurrent_mA
	Battery maximum discharge current, in milliAmps.

static constexpr uint32_t	batteryTypicalPower_mWH = batteryCapacity_mAH * batteryTypicalVoltageSafe_mV / 1000
	Battery standard power, in milliWatt*Hours.

static constexpr bool	usermodeDefaultsToLockdown = false

static constexpr float	c_PI = 3.1415926535897f
	PI constant.

static constexpr float	c_TWO_PI = 6.2831853071795f
	2*PI constant

static constexpr float	c_HALF_PI = 1.5707963267948f
	PI/2 constant.

static constexpr float	c_degreesToRadians = c_PI / 180.0f
	convert degrees to radians

static constexpr uint8_t	USER_SOFTWARE_VERSION_MAJOR = 1

static constexpr uint8_t	USER_SOFTWARE_VERSION_MINOR = 8

static constexpr uint32_t	MAIN_LOOP_UPDATE_PERIOD_MS = static_cast<uint32_t>(1000 / 80.0f)

static constexpr float	consWattByMeter = 12

static constexpr uint16_t	stripInputMinVoltage_mV = 9400

static constexpr uint16_t	stripInputMaxVoltage_mV = 12000

static constexpr float	ledStripLength_mm = 91.0f * 25.0f

static constexpr float	circuitToLedZeroRotationX_degrees = 0.0f

static constexpr float	circuitToLedZeroRotationY_degrees = 0.0f

static constexpr float	circuitToLedZeroRotationZ_degrees = 88.0f

static constexpr float	lampBodyRadius_mm = 25

static constexpr uint16_t	LED_COUNT = 870

static constexpr float	ledByMeter = 244

static constexpr float	ledStripWidth_mm = 5.2f

static constexpr float	ledStripHeigh_mm = 0.7f

static constexpr uint8_t	minimumAllowedBrightness_8 = 3

static constexpr float	ledSize_mm = 1000.0f / ledByMeter

static constexpr float	lampBodyCircumpherence_mm = c_TWO_PI * lampBodyRadius_mm

static constexpr float	ledPerTurn = lampBodyCircumpherence_mm / ledSize_mm

static constexpr float	lampHeight = ledStripWidth_mm * LED_COUNT / ledPerTurn

static constexpr float	stripXCoordinates = lampBodyCircumpherence_mm / ledSize_mm

static constexpr float	stripYCoordinates = ledStripLength_mm / lampBodyCircumpherence_mm

static constexpr float	lampBodyHeight_mm = stripYCoordinates * ledStripWidth_mm

constexpr uint16_t	stripMatrixWidth = ceil(stripXCoordinates)

constexpr uint16_t	stripMatrixHeight = ceil(stripYCoordinates)

Detailed Description

Program scope.

Function Documentation

◆ is_cell_voltage_valid()

bool lampda::is_cell_voltage_valid ( const uint16_t cellVoltage_mv )

inline

check battery cell voltage against min/max limits

Parameters

[in] cellVoltage_mv Voltage to check

◆ lmpd_constrain()

template<typename T >

static constexpr T lampda::lmpd_constrain	(	const T &	a,
		const T &	mini,
		const T &	maxi
	)

staticconstexpr

Constrain a number between two numbers.

Parameters

[in]	a	Number to constrain
[in]	mini	minimum bound
[in]	maxi	maximum bound

Returns: the input number, constraint between mini & maxi

◆ lmpd_map()

template<typename T = float>

static T lampda::lmpd_map	(	float	x,
		const float	in_min,
		const float	in_max,
		const float	out_min,
		const float	out_max
	)

inlinestatic

Linearly interpolate a number between two numbers.

Parameters

[in]	x	Number to map
[in]	in_min	lower bound of the input number
[in]	in_max	higher bound of the input number
[in]	out_min	lower bound of the output number
[in]	out_max	higher bound of the output number

Returns: the input number, mapped between out_min & out_max

◆ main_loop()

void lampda::main_loop ( const uint32_t addedDelay = 0 )

Run the main program loop.

Main loop of the program.

Parameters

[in] addedDelay Debug tool: adds delay to the loop to test errors

Variable Documentation

◆ batteryMaxChargeCurrent_mA

constexpr uint32_t lampda::batteryMaxChargeCurrent_mA

staticconstexpr

Initial value:

=

static_cast<uint32_t>(batteryChargeC_Rate * batteryCapacity_mAH)

lampda::batteryChargeC_Rate

static constexpr float batteryChargeC_Rate

Maximum charge rate.

Definition: constants.h:70

lampda::batteryCapacity_mAH

static constexpr uint32_t batteryCapacity_mAH

Battery capacity, in mA*hours.

Definition: constants.h:72

Battery maximum charge current, in milliAmps.

◆ batteryMaxDischargeCurrent_mA

constexpr uint32_t lampda::batteryMaxDischargeCurrent_mA

staticconstexpr

Initial value:

=

static_cast<uint32_t>(batteryDischargeC_Rate * batteryCapacity_mAH)

lampda::batteryDischargeC_Rate

static constexpr float batteryDischargeC_Rate

Typical discharge rate.

Definition: constants.h:71

Battery maximum discharge current, in milliAmps.

◆ loopDeltaTime

constexpr float lampda::loopDeltaTime = MAIN_LOOP_UPDATE_PERIOD_MS / 1000.0f

staticconstexpr

EXPECTED delta time for each loop run.

Computations from set constants

◆ maxSingularBatteryVoltage_mV

constexpr uint16_t lampda::maxSingularBatteryVoltage_mV

staticconstexpr

Initial value:

=

static_cast<uint16_t>(maxLiionVoltage_mV * 1.01f)

lampda::maxLiionVoltage_mV

static constexpr uint16_t maxLiionVoltage_mV

Absolute maximum allowed Li-ion voltage.

Definition: constants.h:76

with added margins to avoid wrong detection

◆ minSingularBatteryVoltage_mV

constexpr uint16_t lampda::minSingularBatteryVoltage_mV

staticconstexpr

Initial value:

=

static_cast<uint16_t>(minLiionVoltage_mV * 0.9f)

lampda::minLiionVoltage_mV

static constexpr uint16_t minLiionVoltage_mV

minimum Li-ion voltage

Definition: constants.h:74

with added margins to avoid wrong detection

Namespaces

Classes

Typedefs

Functions

Variables

Detailed Description

Function Documentation

◆ is_cell_voltage_valid()

◆ lmpd_constrain()

◆ lmpd_map()

◆ main_loop()

Variable Documentation

◆ batteryMaxChargeCurrent_mA

◆ batteryMaxDischargeCurrent_mA

◆ loopDeltaTime

◆ maxSingularBatteryVoltage_mV

◆ minSingularBatteryVoltage_mV