Accessories
Arduino for motors and lights library.
AccessoryBaseLight Class Reference

#include "AccessoryBaseLight.hpp"

Public Member Functions

 AccessoryBaseLight (Accessory *inpOwner = 0)
 
void begin (Port *inpPort, int inIntensity = 255, Accessory *inpOwner = 0)
 
PortGetPort () const
 
bool IsOn () const
 
bool IsBlinking () const
 
bool IsFading () const
 
void Event (ACCESSORIES_EVENT_TYPE inEvent = ACCESSORIES_EVENT_MOVEPOSITIONID, int inData = 0)
 
void SetBlinking (unsigned long inBlinkingDelay)
 
void SetFading (uint8_t inStep, uint8_t inDelay)
 

Friends

class AccessoryLight
 
class AccessoryLightMulti
 

Detailed Description

This class describes a proxy for a basic light. This is the way to share identical functions and behaviors for many kind of light accessory. A light basically can be on, off, blinking and / or fading (dim light).

Definition at line 26 of file AccessoryBaseLight.hpp.

Constructor & Destructor Documentation

AccessoryBaseLight::AccessoryBaseLight ( Accessory inpOwner = 0)

Default constructor.

Definition at line 33 of file AccessoryBaseLight.cpp.

Member Function Documentation

void AccessoryBaseLight::begin ( Port inpPort,
int  inIntensity = 255,
Accessory inpOwner = 0 
)

Initialize the instance.

Parameters
inpPortPort driven this light.
inIntensityIntensity of this light. Default is maximum, 255.
inpOwnerAddress of the real Accessory owner of this proxy.

Definition at line 82 of file AccessoryBaseLight.cpp.

void AccessoryBaseLight::Event ( ACCESSORIES_EVENT_TYPE  inEvent = ACCESSORIES_EVENT_MOVEPOSITIONID,
int  inData = 0 
)

Execute a new event.

Parameters
inEventType of the new event. Default is ACCESSORIES_EVENT_MOVEPOSITIONID.
inDataAssociated data to the event type. Default is 0.

Definition at line 140 of file AccessoryBaseLight.cpp.

Port* AccessoryBaseLight::GetPort ( ) const
inline

Gets the associated port.

Returns
port address or NULL.

Definition at line 61 of file AccessoryBaseLight.hpp.

bool AccessoryBaseLight::IsBlinking ( ) const
inline

Checks if the light is blinking.

Returns
true if the light is blinking.

Definition at line 69 of file AccessoryBaseLight.hpp.

bool AccessoryBaseLight::IsFading ( ) const
inline

Checks if the light is fading.

Returns
true if the light is fading.
Remarks
A light can dim only with an analog pin.

Definition at line 74 of file AccessoryBaseLight.hpp.

bool AccessoryBaseLight::IsOn ( ) const
inline

Checks if the light is on.

Returns
true if the light is on.

Definition at line 65 of file AccessoryBaseLight.hpp.

void AccessoryBaseLight::SetBlinking ( unsigned long  inBlinkingDelay)
inline

Set the blinking mode, with a duration for a blink.

Parameters
inBlinkingDelayDuration of the light on state. The same duration is applied for light off.

Definition at line 84 of file AccessoryBaseLight.hpp.

void AccessoryBaseLight::SetFading ( uint8_t  inStep,
uint8_t  inDelay 
)

Set the fading mode, defining its speed.

Parameters
inStepNumber of steps between light on and light off.
inDelayDuration of each step.

Definition at line 68 of file AccessoryBaseLight.cpp.


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