pixelkey/pixelkey_8h_source.html

#ifndef PIXELKEY_H

#define PIXELKEY_H


#include <stdbool.h>

#include <stdint.h>


#include "helper_macros.h"


#include "color.h"


#include "pixelkey_errors.h"

#include "pixelkey_commands.h"


#include "keyframes.h"


void pixelkey_frameproc_init(framerate_t framerate);

void pixelkey_keyframeproc_framerate_set(framerate_t framerate);

uint32_t pixelkey_keyframeproc_framecount_get(void);

pixelkey_error_t pixelkey_keyframeproc_render_frame(color_rgb_t * p_frame_buffer);

pixelkey_error_t pixelkey_keyframeproc_push(uint8_t index, keyframe_base_t * p_keyframe);


void pixelkey_commandproc_init(void);

void pixelkey_commandproc_task(void);

void pixelkey_commandproc_terminal_connected(void);

void pixelkey_commandproc_send_prompt(void);

pixelkey_error_t pixelkey_commandproc_push(cmd_t * p_cmd);


#endif // PIXELKEY_H

framerate_t
uint8_t framerate_t
Number of frames per second.
Definition: keyframes.h:55

pixelkey_commandproc_terminal_connected
void pixelkey_commandproc_terminal_connected(void)
Writes the initial device info and terminal prompt when a terminal attach is detected.
Definition: command_processor.c:161

pixelkey_keyframeproc_framerate_set
void pixelkey_keyframeproc_framerate_set(framerate_t framerate)
Sets the framerate used to render keyframes.
Definition: keyframe_processor.c:161

pixelkey_commandproc_init
void pixelkey_commandproc_init(void)
Initialize the command processor.
Definition: command_processor.c:107

pixelkey_error_t
pixelkey_error_t
PixelKey errors.
Definition: pixelkey_errors.h:11

pixelkey_keyframeproc_framecount_get
uint32_t pixelkey_keyframeproc_framecount_get(void)
Gets the total numbered of rendered frames.
Definition: keyframe_processor.c:180

pixelkey_frameproc_init
void pixelkey_frameproc_init(framerate_t framerate)
Initializes the keyframe processor.
Definition: keyframe_processor.c:189

pixelkey_keyframeproc_render_frame
pixelkey_error_t pixelkey_keyframeproc_render_frame(color_rgb_t *p_frame_buffer)
Performs a render of the current keyframes.
Definition: keyframe_processor.c:57

pixelkey_commandproc_task
void pixelkey_commandproc_task(void)
Executes queued commands.
Definition: command_processor.c:131

pixelkey_commandproc_send_prompt
void pixelkey_commandproc_send_prompt(void)
Writes the terminal prompt.
Definition: command_processor.c:176

pixelkey_commandproc_push
pixelkey_error_t pixelkey_commandproc_push(cmd_t *p_cmd)
Pushes a command to the processor buffer.
Definition: command_processor.c:118

pixelkey_keyframeproc_push
pixelkey_error_t pixelkey_keyframeproc_push(uint8_t index, keyframe_base_t *p_keyframe)
Pushes a keyframe into the queue for a given NeoPixel index.
Definition: keyframe_processor.c:143

pixelkey_commands.h

cmd_t
Parsed command and arguments.
Definition: pixelkey_commands.h:131

color_rgb_t
Color represented in red-green-blue color space.
Definition: color.h:70