led3.c File Reference

mikrosdk interface More...

#include "led3_click.h"
#include "led3_drv.h"
#include "cascoda-bm/cascoda_sensorif.h"
#include "cascoda-bm/cascoda_wait.h"
#include "cascoda-util/cascoda_time.h"

Include dependency graph for led3.c:

Functions
uint8_t	MIKROSDK_LED3_set_dimming_and_intensity (uint8_t cmd)
	Function that sets the dimming mode (Increment, Decrement, Constant) and the light intensity. More...
uint8_t	MIKROSDK_LED3_set_rgb (uint8_t red, uint8_t green, uint8_t blue)
	Function that sets the rgb value individually. More...
uint8_t	MIKROSDK_LED3_set_colour (uint32_t colour)
	Function that sets the LED using common colours. More...
uint8_t	MIKROSDK_LED3_shut_down (void)
	Function that turns off the LED. More...
uint8_t	MIKROSDK_LED3_set_timer (uint8_t time)
	Function that sets the time interval for the dimming function. More...
uint8_t	MIKROSDK_LED3_Initialise (void)
	Function that initialises the I2C configuration of the LED3 click. More...

Detailed Description

mikrosdk interface

Function Documentation

MIKROSDK_LED3_Initialise()

uint8_t MIKROSDK_LED3_Initialise

(

void

)

Function that initialises the I2C configuration of the LED3 click.

Returns

uint8_t

MIKROSDK_LED3_set_colour()

uint8_t MIKROSDK_LED3_set_colour

(

uint32_t

colour

)

Function that sets the LED using common colours.

Parameters

colour

Defined commonly used colours. E.g, LED3_COLOUR_PURPLE.

Returns

uint8_t

MIKROSDK_LED3_set_dimming_and_intensity()

uint8_t MIKROSDK_LED3_set_dimming_and_intensity

(

uint8_t

cmd

)

Function that sets the dimming mode (Increment, Decrement, Constant) and the light intensity.

Parameters

cmd	Bitwise OR of dimming mode and light intensity. E.g, to use constant brightness with max intensity, use (LED3_CONSTANT | LED3_INTENSITY_MAX).

Returns

uint8_t

MIKROSDK_LED3_set_rgb()

uint8_t MIKROSDK_LED3_set_rgb	(	uint8_t	red,
		uint8_t	green,
		uint8_t	blue
	)

Function that sets the rgb value individually.

Parameters

red	Red colour value (MIN = 0x40, MAX = 0x5F).
green	Green colour value (MIN = 0x60, MAX = 0x7F).
blue	Blue colour value (MIN = 0x80, MAX = 0x9F).

Returns

uint8_t

MIKROSDK_LED3_set_timer()

uint8_t MIKROSDK_LED3_set_timer

(

uint8_t

time

)

Function that sets the time interval for the dimming function.

Parameters

time	Time interval for dimming. If set to 32ms, the LED will dim to the specified intensity at 32ms per intensity step. E.g, current intensity = 5, new intensity = 15, the total dimming sequence will take 320ms.

Returns

uint8_t

MIKROSDK_LED3_shut_down()

uint8_t MIKROSDK_LED3_shut_down

(

void

)

Function that turns off the LED.

Returns

uint8_t