roneos
Operating System for the r-one robot
 All Data Structures Files Functions Variables Typedefs Groups
pwm.h File Reference

This is a PWM module which was originally created for the IR beacon. It is meant to control some PWM setup, but mostly for setting and changing PWM on the 8962 pins. PWM outputs are used for things like single LEDs and the power adjustment on the IR beacons. More...

Go to the source code of this file.

Functions

void pwmInitializeLed (void)
 Initializes the PWM pins. Configures the RGB LEDs to be countdown PWM pins. They are flashed once. More...
 
void pwmInitializeBeacon (void)
 Sets up the PWM pins for the IR beacon PWM control. More...
 
void pwmSetDuty (uint32 pwm_target, uint16 duty)
 
void pwmSetDutyAllLeds (uint16 duty)
 Changes the duty cycle for all of the LED PWM pins period is the current length of the entire PWM period. More...
 
void pwmEnableSingle (uint32 pin_name)
 This enables the output of the given pwm pin. The input argument should be the name of the function of a given PWM pin, i.e. RED_LED. More...
 
void pwmEnableAllLeds (void)
 Enables the pwm output for all 3 LEDs. More...
 
void pwmDisableSingle (uint32 pin_name)
 This disables the output of the given pwm pins. The input argument should be any logical OR of valid PWM BIT pin names, e.g. RED_LED_PWM_BIT. More...
 
void pwmDisableAllLeds (void)
 This disables the output of the all pwm pins. More...
 

Detailed Description

This is a PWM module which was originally created for the IR beacon. It is meant to control some PWM setup, but mostly for setting and changing PWM on the 8962 pins. PWM outputs are used for things like single LEDs and the power adjustment on the IR beacons.

Since
Jun 1, 2012
Author
Lindsay

Function Documentation

void pwmDisableAllLeds ( void  )

This disables the output of the all pwm pins.

Returns
void
void pwmDisableSingle ( uint32  pin_name)

This disables the output of the given pwm pins. The input argument should be any logical OR of valid PWM BIT pin names, e.g. RED_LED_PWM_BIT.

Parameters
pin_name- name of pins wanted to change
Returns
void
void pwmEnableAllLeds ( void  )

Enables the pwm output for all 3 LEDs.

Returns
void
void pwmEnableSingle ( uint32  pin_name)

This enables the output of the given pwm pin. The input argument should be the name of the function of a given PWM pin, i.e. RED_LED.

Parameters
pin_name- name of pins wanted to change
Returns
void
void pwmInitializeBeacon ( void  )

Sets up the PWM pins for the IR beacon PWM control.

Returns
voids
void pwmInitializeLed ( void  )

Initializes the PWM pins. Configures the RGB LEDs to be countdown PWM pins. They are flashed once.

Returns
void
void pwmSetDuty ( uint32  pwm_target,
uint16  duty 
)

Brief: Sets the duty cycle length for one pin period is the current length of the entire PWM period

Parameters
pwm_targetis the pin which needs to have its duty cycle changed. In the IR beacon it is colors
dutyis the duty cycle for when the pin is ON, and can range from 0 to 100
Returns
void
void pwmSetDutyAllLeds ( uint16  duty)

Changes the duty cycle for all of the LED PWM pins period is the current length of the entire PWM period.

Parameters
dutyis the length of the new duty cycle and should be 0-100
Returns
void