Mercurial > hg > beaglert
changeset 48:42a683058b6a newapi
Documentation updates, and move some defines from BeagleRT.h into specific projects where they are used
| author | andrewm |
|---|---|
| date | Thu, 28 May 2015 17:23:33 -0400 |
| parents | 643cbee74eda |
| children | bb40e7e06b8c |
| files | Doxyfile include/BeagleRT.h projects/d-box/render.cpp |
| diffstat | 3 files changed, 35 insertions(+), 21 deletions(-) [+] |
line wrap: on
line diff
--- a/Doxyfile Thu May 28 17:06:03 2015 -0400 +++ b/Doxyfile Thu May 28 17:23:33 2015 -0400 @@ -648,7 +648,7 @@ # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = +INPUT = include/BeagleRT.h # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
--- a/include/BeagleRT.h Thu May 28 17:06:03 2015 -0400 +++ b/include/BeagleRT.h Thu May 28 17:23:33 2015 -0400 @@ -11,6 +11,19 @@ * Queen Mary University of London */ +/** + * \mainpage + * + * BeagleRT is a hard-real-time, ultra-low latency audio and sensor environment for + * BeagleBone Black, which works with the BeagleBone Audio Cape or a custom "BeagleRT Cape" + * which incorporates stereo audio with 8x, 16-bit analog inputs and outputs. + * + * BeagleRT is based on the Xenomai real-time Linux extensions (http://xenomai.org) and + * uses the BeagleBone %PRU subsystem to address the audio and sensor hardware. + * + * Further information can be found at http://beaglert.cc + */ + #ifndef BEAGLERT_H_ #define BEAGLERT_H_ @@ -74,26 +87,6 @@ */ #define BEAGLERT_FLAG_ANALOG_OUTPUTS_PERSIST (1 << 1) // Set if analog/digital outputs persist for future buffers -// Mappings from pin numbers on PCB to actual DAC channels -// This gives the DAC and ADC connectors the same effective pinout -#define DAC_PIN0 6 -#define DAC_PIN1 4 -#define DAC_PIN2 2 -#define DAC_PIN3 0 -#define DAC_PIN4 1 -#define DAC_PIN5 3 -#define DAC_PIN6 5 -#define DAC_PIN7 7 - -#define ADC_PIN0 0 -#define ADC_PIN1 1 -#define ADC_PIN2 2 -#define ADC_PIN3 3 -#define ADC_PIN4 4 -#define ADC_PIN5 5 -#define ADC_PIN6 6 -#define ADC_PIN7 7 - /** * \ingroup control * \brief Structure containing initialisation parameters for the real-time
--- a/projects/d-box/render.cpp Thu May 28 17:06:03 2015 -0400 +++ b/projects/d-box/render.cpp Thu May 28 17:23:33 2015 -0400 @@ -19,6 +19,27 @@ #undef DBOX_CAPE_TEST +// Mappings from pin numbers on PCB to actual DAC channels +// This gives the DAC and ADC connectors the same effective pinout +#define DAC_PIN0 6 +#define DAC_PIN1 4 +#define DAC_PIN2 2 +#define DAC_PIN3 0 +#define DAC_PIN4 1 +#define DAC_PIN5 3 +#define DAC_PIN6 5 +#define DAC_PIN7 7 + +#define ADC_PIN0 0 +#define ADC_PIN1 1 +#define ADC_PIN2 2 +#define ADC_PIN3 3 +#define ADC_PIN4 4 +#define ADC_PIN5 5 +#define ADC_PIN6 6 +#define ADC_PIN7 7 + + #define N_OCT 4.0 // maximum number of octaves on sensor 1 extern vector<OscillatorBank*> gOscBanks;