edit doc mark
This commit is contained in:
parent
7852f22295
commit
31d02bbb3e
|
|
@ -1,5 +1,5 @@
|
|||
/** \file rpi_selector.c
|
||||
* \brief This module is used to manage selector on gpio
|
||||
/** @file rpi_selector.c
|
||||
* @brief This module is used to manage selector on gpio
|
||||
*/
|
||||
|
||||
/***************************************************************************************************
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/** \file rpi_selector.h
|
||||
* \brief This module is used to manage selector on gpio
|
||||
/** @file rpi_selector.h
|
||||
* @brief This module is used to manage selector on gpio
|
||||
*/
|
||||
/***************************************************************************************************
|
||||
* Includes
|
||||
|
|
@ -23,17 +23,17 @@
|
|||
* External Function Prototypes
|
||||
**************************************************************************************************/
|
||||
/**
|
||||
* \brief setup the selector module
|
||||
* @brief setup the selector module
|
||||
**/
|
||||
void selector_setup();
|
||||
|
||||
/**
|
||||
* \brief get the selector position
|
||||
* @brief get the selector position
|
||||
**/
|
||||
int selector_get_position();
|
||||
|
||||
/**
|
||||
* \brief Get string with selector debug info
|
||||
* @brief Get string with selector debug info
|
||||
**/
|
||||
char *selector_tostr();
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/** \file main.c
|
||||
* \brief This is the main exectution program
|
||||
/** @file main.c
|
||||
* @brief This is the main exectution program
|
||||
*/
|
||||
|
||||
/***************************************************************************************************
|
||||
|
|
@ -23,6 +23,7 @@
|
|||
|
||||
#include "tasks/artnet/rpi_artnet.h"
|
||||
#include "tasks/cava/rpi_cava.h"
|
||||
#include "tasks/websocket/rpi_websocket.h"
|
||||
|
||||
#include "rpi_midi_controller.h"
|
||||
#include "rpi_param.h"
|
||||
|
|
@ -94,6 +95,7 @@ int main(int argc, char const *argv[]) {
|
|||
midi_controller_setup();
|
||||
selector_setup();
|
||||
leddriver_setup();
|
||||
websocket_start();
|
||||
|
||||
parseCommandLineArgs(argc, argv);
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/** \file .c
|
||||
* \brief This module
|
||||
/** @file .c
|
||||
* @brief This module
|
||||
*/
|
||||
|
||||
/***************************************************************************************************
|
||||
|
|
@ -52,28 +52,28 @@ int destChannel = 0xf;
|
|||
**************************************************************************************************/
|
||||
|
||||
/**
|
||||
* \brief
|
||||
* @brief
|
||||
*/
|
||||
void subscribe_system_port();
|
||||
|
||||
/**
|
||||
* \brief
|
||||
* @brief
|
||||
*
|
||||
* \param controller
|
||||
* @param controller
|
||||
*/
|
||||
void subscribe_midi_controller(snd_seq_addr_t controller);
|
||||
|
||||
/**
|
||||
* \brief
|
||||
* @brief
|
||||
*
|
||||
* \param ev
|
||||
* @param ev
|
||||
*/
|
||||
void handle_system_port_events(snd_seq_event_t *ev);
|
||||
|
||||
/**
|
||||
* \brief
|
||||
* @brief
|
||||
*
|
||||
* \param ev
|
||||
* @param ev
|
||||
*/
|
||||
void handle_in_port_events(snd_seq_event_t *ev);
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/** \file .h
|
||||
* \brief This module
|
||||
/** @file .h
|
||||
* @brief This module
|
||||
*/
|
||||
#if !defined(__RPI_MIDI_CONTROLLER_H__)
|
||||
#define __RPI_MIDI_CONTROLLER_H__
|
||||
|
|
@ -25,17 +25,17 @@
|
|||
**************************************************************************************************/
|
||||
|
||||
/**
|
||||
* \brief
|
||||
* @brief
|
||||
*/
|
||||
void midi_controller_setup();
|
||||
|
||||
/**
|
||||
* \brief
|
||||
* @brief
|
||||
*/
|
||||
void midi_controller_execute();
|
||||
|
||||
/**
|
||||
* \brief
|
||||
* @brief
|
||||
*/
|
||||
void midi_controller_close();
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/** \file .c
|
||||
* \brief This module
|
||||
/** @file .c
|
||||
* @brief This module
|
||||
*/
|
||||
|
||||
/***************************************************************************************************
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/** \file .h
|
||||
* \brief This module
|
||||
/** @file .h
|
||||
* @brief This module
|
||||
*/
|
||||
|
||||
#if !defined(__RPI_PARAM_H__)
|
||||
|
|
@ -87,37 +87,37 @@ param_t *param_access;
|
|||
**************************************************************************************************/
|
||||
|
||||
/**
|
||||
* \brief
|
||||
* @brief
|
||||
*/
|
||||
void param_setup();
|
||||
|
||||
/**
|
||||
* \brief
|
||||
* @brief
|
||||
*
|
||||
* \param[in] pattern
|
||||
* @param[in] pattern
|
||||
*/
|
||||
void set_pattern(unsigned int pattern);
|
||||
|
||||
/**
|
||||
* \brief
|
||||
* @brief
|
||||
*
|
||||
* \param[in] HasToBeEnabled
|
||||
* @param[in] HasToBeEnabled
|
||||
*/
|
||||
void set_hue_auto_shift(bool HasToBeEnabled);
|
||||
|
||||
/**
|
||||
* \brief
|
||||
* @brief
|
||||
*
|
||||
* \param[in] gravity8
|
||||
* @param[in] gravity8
|
||||
*/
|
||||
void set_gravity(int8_t gravity8);
|
||||
|
||||
/**
|
||||
* \brief
|
||||
* @brief
|
||||
*
|
||||
* \param[in] channel
|
||||
* @param[in] channel
|
||||
*
|
||||
* \param[in] sensitivity8
|
||||
* @param[in] sensitivity8
|
||||
*/
|
||||
void set_sensitivity(int channel, int8_t sensitivity8);
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/** \file .c
|
||||
* \brief This module
|
||||
/** @file .c
|
||||
* @brief This module
|
||||
*/
|
||||
|
||||
/***************************************************************************************************
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/** \file .h
|
||||
* \brief This module
|
||||
/** @file .h
|
||||
* @brief This module
|
||||
*/
|
||||
|
||||
#if !defined(__RPI_PATTERN_H__)
|
||||
|
|
@ -28,29 +28,29 @@
|
|||
**************************************************************************************************/
|
||||
|
||||
/**
|
||||
* \brief
|
||||
* @brief
|
||||
*
|
||||
* \param[in] spectrumArray array of value from spectral analysis
|
||||
* @param[in] spectrumArray array of value from spectral analysis
|
||||
*
|
||||
* \param[in] spectrumLength length of spectrum array
|
||||
* @param[in] spectrumLength length of spectrum array
|
||||
*/
|
||||
void bounce_led_and_color(uint16_t *spectrumArray, unsigned int spectrumLength);
|
||||
|
||||
/**
|
||||
* \brief
|
||||
* @brief
|
||||
*
|
||||
* \param[in] spectrumArray array of value from spectral analysis
|
||||
* @param[in] spectrumArray array of value from spectral analysis
|
||||
*
|
||||
* \param[in] spectrumLength length of spectrum array
|
||||
* @param[in] spectrumLength length of spectrum array
|
||||
*/
|
||||
void bounce_led(uint16_t *spectrumArray, unsigned int spectrumLength);
|
||||
|
||||
/**
|
||||
* \brief
|
||||
* @brief
|
||||
*
|
||||
* \param[in] spectrumArray array of value from spectral analysis
|
||||
* @param[in] spectrumArray array of value from spectral analysis
|
||||
*
|
||||
* \param[in] spectrumLength length of spectrum array
|
||||
* @param[in] spectrumLength length of spectrum array
|
||||
*/
|
||||
void bounce_led_and_travel(uint16_t *spectrumArray, unsigned int spectrumLength);
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/** \file rpi_artnet.c
|
||||
* \brief This module contains continuous tasks for artnet node communications.
|
||||
/** @file rpi_artnet.c
|
||||
* @brief This module contains continuous tasks for artnet node communications.
|
||||
*
|
||||
* This is the implementation file.
|
||||
*/
|
||||
|
|
@ -53,20 +53,20 @@ uint8_t artDmxBufferArray[16][512];
|
|||
**************************************************************************************************/
|
||||
|
||||
/**
|
||||
* \brief This function is used to thread main execution function
|
||||
* @brief This function is used to thread main execution function
|
||||
*
|
||||
* \param arg not used.
|
||||
* @param arg not used.
|
||||
*
|
||||
* \return NULL.
|
||||
* @return NULL.
|
||||
*/
|
||||
static void *artnet_udp_handler(void *arg);
|
||||
|
||||
/**
|
||||
* \brief This function is used to send an artnet poll reply packet
|
||||
* @brief This function is used to send an artnet poll reply packet
|
||||
*
|
||||
* \param[in] fdUdpSocket The UDP socket file descriptor.
|
||||
* @param[in] fdUdpSocket The UDP socket file descriptor.
|
||||
*
|
||||
* \param[in] senderAddr The adress of poll emiter.
|
||||
* @param[in] senderAddr The adress of poll emiter.
|
||||
*/
|
||||
static void artnet_send_poll_reply(int fdUdpSocket, struct sockaddr_in senderAddr);
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/** \file rpi_artnet.h
|
||||
* \brief This module contains continuous tasks for artnet node communications.
|
||||
/** @file rpi_artnet.h
|
||||
* @brief This module contains continuous tasks for artnet node communications.
|
||||
*
|
||||
* This is the header file for the definition of services to allow managing thread acting as artnet
|
||||
* node.
|
||||
|
|
@ -29,21 +29,21 @@
|
|||
**************************************************************************************************/
|
||||
|
||||
/**
|
||||
* \brief Start artnet node module
|
||||
* @brief Start artnet node module
|
||||
**/
|
||||
void artnet_start();
|
||||
|
||||
/**
|
||||
* \brief Stop artnet node module
|
||||
* @brief Stop artnet node module
|
||||
*/
|
||||
void artnet_stop();
|
||||
|
||||
/**
|
||||
* \brief Get last DMX data received for the specified universe
|
||||
* @brief Get last DMX data received for the specified universe
|
||||
*
|
||||
* \param[in] univerve The universe to get data from
|
||||
* @param[in] univerve The universe to get data from
|
||||
*
|
||||
* \param[out] dmxData The pointer to the DMX data array
|
||||
* @param[out] dmxData The pointer to the DMX data array
|
||||
*/
|
||||
int artnet_get_dmx_data(unsigned int univerve, uint8_t *dmxData[]);
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/** \file rpi_cava.h
|
||||
* \brief This module contains continuous tasks for cava (spectrum analyzer) comunication
|
||||
/** @file rpi_cava.h
|
||||
* @brief This module contains continuous tasks for cava (spectrum analyzer) comunication
|
||||
*/
|
||||
|
||||
/***************************************************************************************************
|
||||
|
|
@ -60,11 +60,11 @@ uint16_t buffer[128 + 2];
|
|||
**************************************************************************************************/
|
||||
|
||||
/**
|
||||
* \brief This function is used to thread main execution function
|
||||
* @brief This function is used to thread main execution function
|
||||
*
|
||||
* \param arg not used.
|
||||
* @param arg not used.
|
||||
*
|
||||
* \return NULL.
|
||||
* @return NULL.
|
||||
*/
|
||||
static void *fifo_to_buffer(void *arg);
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/** \file rpi_cava.h
|
||||
* \brief This module contains continuous tasks for cava (spectrum analyzer) comunication
|
||||
/** @file rpi_cava.h
|
||||
* @brief This module contains continuous tasks for cava (spectrum analyzer) comunication
|
||||
*/
|
||||
#if !defined(__RPI_CAVA_H__)
|
||||
#define __RPI_CAVA_H__
|
||||
|
|
@ -29,7 +29,7 @@
|
|||
**************************************************************************************************/
|
||||
|
||||
/**
|
||||
* \brief Start artnet node module
|
||||
* @brief Start artnet node module
|
||||
**/
|
||||
void setup_cava();
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user