S11059_ex.h File Reference

S11059 Driver extensions. More...

#include "sarmfsw.h"
#include "S11059.h"

Include dependency graph for S11059_ex.h:

This graph shows which files directly or indirectly include this file:

Data Structures
union	uS11059_REG_MAP
	Union of S11059 registry map. More...

Enumerations
enum	S11059_chan { S11059__CHAN_RED = 0U , S11059__CHAN_GREEN , S11059__CHAN_BLUE , S11059__CHAN_IR }
	Light type channels of S11059. More...

Functions
FctERR	S11059_Write_Ctl (I2C_slave_t *const pSlave, const uint8_t ctl)
	Write S11059 Control register.
FctERR	S11059_Set_ADC (S11059_t *const pCpnt, const S11059_adc_reset adc)
	ADC Operation / Reset.
FctERR	S11059_Set_Standby (S11059_t *const pCpnt, const S11059_standby_fct standby)
	Set Standby / Operating mode.
FctERR	S11059_Set_Gain (S11059_t *const pCpnt, const S11059_gain gain)
	Set ADC gain.
FctERR	S11059_Set_Integration (S11059_t *const pCpnt, const S11059_integ mode, const S11059_prescaler prescaler)
	Set integration mode & prescaler.
FctERR	S11059_Set_Integration_Multiplier (S11059_t *const pCpnt, const uint16_t mult)
	Set S11059 integration multiplier (used when integration mode set to Manual)
FctERR	S11059_Get_Standby (S11059_t *const pCpnt, S11059_standby_fct *const standby)
	Get Standby function monitor.
FctERR	S11059_Get_Channel (S11059_t *const pCpnt, uint16_t *const val, const S11059_chan chan)
	Get Specific channel conversion.
FctERR	S11059_Get_Red (S11059_t *const pCpnt, uint16_t *const r)
	Get Red channel conversion.
FctERR	S11059_Get_Green (S11059_t *const pCpnt, uint16_t *const g)
	Get Green channel conversion.
FctERR	S11059_Get_Blue (S11059_t *const pCpnt, uint16_t *const b)
	Get Blue channel conversion.
FctERR	S11059_Get_IR (S11059_t *const pCpnt, uint16_t *const ir)
	Get Infra-red channel conversion.

Detailed Description

S11059 Driver extensions.

Author

SMFSW

Copyright

MIT (c) 2017-2026, SMFSW

S11059: I2C interface-compatible color sensor

Enumeration Type Documentation

S11059_chan

enum S11059_chan

Light type channels of S11059.

Enumerator
S11059__CHAN_RED	Red light channel.
S11059__CHAN_GREEN	Green light channel.
S11059__CHAN_BLUE	Blue light channel.
S11059__CHAN_IR	Infra-red light channel.

Function Documentation

S11059_Get_Blue()

FctERR S11059_Get_Blue ( S11059_t *const pCpnt, uint16_t *const b )

inline

Get Blue channel conversion.

Parameters

[in]	pCpnt	- Pointer to S11059 component
[in,out]	b	- pointer to Blue conversion result

Returns

FctERR - error code

Here is the call graph for this function:

S11059_Get_Channel()

FctERR S11059_Get_Channel	(	S11059_t *const	pCpnt,
		uint16_t *const	val,
		const S11059_chan	chan )

Get Specific channel conversion.

Parameters

[in]	pCpnt	- Pointer to S11059 component
[in,out]	val	- pointer to conversions result
[in]	chan	- Channel to get

Returns

FctERR - error code

Here is the call graph for this function:

S11059_Get_Green()

FctERR S11059_Get_Green ( S11059_t *const pCpnt, uint16_t *const g )

inline

Get Green channel conversion.

Parameters

[in]	pCpnt	- Pointer to S11059 component
[in,out]	g	- pointer to Green conversion result

Returns

FctERR - error code

Here is the call graph for this function:

S11059_Get_IR()

FctERR S11059_Get_IR ( S11059_t *const pCpnt, uint16_t *const ir )

inline

Get Infra-red channel conversion.

Parameters

[in]	pCpnt	- Pointer to S11059 component
[in,out]	ir	- pointer to Infra-red conversion result

Returns

FctERR - error code

Here is the call graph for this function:

S11059_Get_Red()

FctERR S11059_Get_Red ( S11059_t *const pCpnt, uint16_t *const r )

inline

Get Red channel conversion.

Parameters

[in]	pCpnt	- Pointer to S11059 component
[in,out]	r	- pointer to Red conversion result

Returns

FctERR - error code

Here is the call graph for this function:

S11059_Get_Standby()

FctERR S11059_Get_Standby	(	S11059_t *const	pCpnt,
		S11059_standby_fct *const	standby )

Get Standby function monitor.

Parameters

[in]	pCpnt	- Pointer to S11059 component
[in,out]	standby	- pointer to standby function result

Returns

FctERR - error code

Here is the call graph for this function:

S11059_Set_ADC()

FctERR S11059_Set_ADC	(	S11059_t *const	pCpnt,
		const S11059_adc_reset	adc )

ADC Operation / Reset.

Parameters

[in]	pCpnt	- Pointer to S11059 component
[in]	adc	- ADC mode

Returns

FctERR - error code

Here is the call graph for this function:

S11059_Set_Gain()

FctERR S11059_Set_Gain	(	S11059_t *const	pCpnt,
		const S11059_gain	gain )

Set ADC gain.

Parameters

[in]	pCpnt	- Pointer to S11059 component
[in]	gain	- Gain selection

Returns

FctERR - error code

Here is the call graph for this function:

S11059_Set_Integration()

FctERR S11059_Set_Integration	(	S11059_t *const	pCpnt,
		const S11059_integ	mode,
		const S11059_prescaler	prescaler )

Set integration mode & prescaler.

Parameters

[in]	pCpnt	- Pointer to S11059 component
[in]	mode	- Fixed period / Manual integration
[in]	prescaler	- Integration time base (prescaler)

Returns

FctERR - error code

Here is the call graph for this function:

S11059_Set_Integration_Multiplier()

FctERR S11059_Set_Integration_Multiplier	(	S11059_t *const	pCpnt,
		const uint16_t	mult )

Set S11059 integration multiplier (used when integration mode set to Manual)

Parameters

[in]	pCpnt	- Pointer to S11059 component
[in]	mult	- Integration time multiplier value

Returns

FctERR - error code

Here is the call graph for this function:

S11059_Set_Standby()

FctERR S11059_Set_Standby	(	S11059_t *const	pCpnt,
		const S11059_standby_fct	standby )

Set Standby / Operating mode.

Parameters

[in]	pCpnt	- Pointer to S11059 component
[in]	standby	- standby mode

Returns

FctERR - error code

Here is the call graph for this function:

S11059_Write_Ctl()

FctERR S11059_Write_Ctl ( I2C_slave_t *const pSlave, const uint8_t ctl )

inline

Write S11059 Control register.

Parameters

[in]	pSlave	- Pointer to I2C slave instance
[in]	ctl	- Control value

Returns

FctERR - error code

Here is the call graph for this function:

Here is the caller graph for this function: