Bulb PWM Driver Callbacks#
These callbacks are contributed by the Bulb PWM Driver plugin.
Functions#
Configures the frequency of the PWM driver. Called by the bulb-pwm driver upon initialization to determine the frequency at which the PWM driver should be driven. It should return either the frequency, in Hz, or USE_DEFAULT_FREQUENCY to indicate that the plugin should use the default value. The default value is 1000 Hz, but can be overridden by a macro in the board header.
Indicates that the PWM driver has been initialized and the bulb should drive the initial LED PWM values at this time.
Generated during blinking behavior when it is time to turn the bulb on. While the plugin will determine when to blink the bulb on or off, it is up to this callback to determine how to turn the bulb on.
Generated during blinking behavior when it is time to turn the bulb off. While the plugin will determine when to blink the bulb on or off, it is up to this callback to determine how to turn the bulb off.
Generated when the application layer makes a call to initiate blinking behavior. It warns the application layer PWM code not to attempt to drive the LEDs directly and interfere with the blinking behavior.
Generated when the current blinking command finishes. The application layer PWM code must then determine what the bulb drive should be, based on the current application layer attributes (i.e., level, on/off, color XY, and so on.)
Function Documentation#
halBulbPwmDriverFrequencyCallback#
uint16_t halBulbPwmDriverFrequencyCallback (void )
Configures the frequency of the PWM driver. Called by the bulb-pwm driver upon initialization to determine the frequency at which the PWM driver should be driven. It should return either the frequency, in Hz, or USE_DEFAULT_FREQUENCY to indicate that the plugin should use the default value. The default value is 1000 Hz, but can be overridden by a macro in the board header.
| N/A |
@appusage Should be implemented by an application layer configuration plugin.
123 of file ./app/ncp/doc/callback.dochalBulbPwmDriverInitCompleteCallback#
void halBulbPwmDriverInitCompleteCallback (void )
Indicates that the PWM driver has been initialized and the bulb should drive the initial LED PWM values at this time.
| N/A |
@appusage Should be implemented by an application layer configuration plugin.
135 of file ./app/ncp/doc/callback.dochalBulbPwmDriverBlinkOnCallback#
void halBulbPwmDriverBlinkOnCallback (void )
Generated during blinking behavior when it is time to turn the bulb on. While the plugin will determine when to blink the bulb on or off, it is up to this callback to determine how to turn the bulb on.
| N/A |
@appusage Should be implemented by an application layer configuration plugin.
148 of file ./app/ncp/doc/callback.dochalBulbPwmDriverBlinkOffCallback#
void halBulbPwmDriverBlinkOffCallback (void )
Generated during blinking behavior when it is time to turn the bulb off. While the plugin will determine when to blink the bulb on or off, it is up to this callback to determine how to turn the bulb off.
| N/A |
@appusage Should be implemented by an application layer configuration plugin.
176 of file ./app/ncp/doc/callback.dochalBulbPwmDriverBlinkStartCallback#
void halBulbPwmDriverBlinkStartCallback (void )
Generated when the application layer makes a call to initiate blinking behavior. It warns the application layer PWM code not to attempt to drive the LEDs directly and interfere with the blinking behavior.
| N/A |
@appusage Should be implemented by an application layer configuration plugin.
204 of file ./app/ncp/doc/callback.dochalBulbPwmDriverBlinkStopCallback#
void halBulbPwmDriverBlinkStopCallback (void )
Generated when the current blinking command finishes. The application layer PWM code must then determine what the bulb drive should be, based on the current application layer attributes (i.e., level, on/off, color XY, and so on.)
| N/A |
@appusage Should be implemented by an application layer configuration plugin.
217 of file ./app/ncp/doc/callback.doc