amiro-lld / docs / periphery-lld.dox @ ef5bc242
History | View | Annotate | Download (2.82 KB)
| 1 |
/* |
|---|---|
| 2 |
AMiRo-LLD is a compilation of low-level hardware drivers for the Autonomous Mini Robot (AMiRo) platform. |
| 3 |
Copyright (C) 2016..2019 Thomas Schöpping et al. |
| 4 |
|
| 5 |
This program is free software: you can redistribute it and/or modify |
| 6 |
it under the terms of the GNU General Public License as published by |
| 7 |
the Free Software Foundation, either version 3 of the License, or |
| 8 |
(at your option) any later version. |
| 9 |
|
| 10 |
This program is distributed in the hope that it will be useful, |
| 11 |
but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 12 |
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 13 |
GNU General Public License for more details. |
| 14 |
|
| 15 |
You should have received a copy of the GNU General Public License |
| 16 |
along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 17 |
*/ |
| 18 |
|
| 19 |
/** |
| 20 |
* @defgroup periphery AMiRo-LLD |
| 21 |
* @details AMiRo Low Level Driver Documentation |
| 22 |
*/ |
| 23 |
|
| 24 |
/** |
| 25 |
* @defgroup lld_motor A3906 (Motor Driver) |
| 26 |
* @details Motor Driver Documentation |
| 27 |
* @ingroup periphery |
| 28 |
*/ |
| 29 |
|
| 30 |
/** |
| 31 |
* @defgroup lld_eeprom At24c01bn-sh-b (EEPROM) |
| 32 |
* @details EEPROM Documentation |
| 33 |
* @ingroup periphery |
| 34 |
*/ |
| 35 |
|
| 36 |
/** |
| 37 |
* @defgroup lld_charger Bq24103a (Battery Charger) |
| 38 |
* @details Battery Charger Documentation |
| 39 |
* @ingroup periphery |
| 40 |
*/ |
| 41 |
|
| 42 |
/** |
| 43 |
* @defgroup lld_gauge Bq27500 (Fuel Gauge) |
| 44 |
* @details Fuel Gauge Documentation |
| 45 |
* @ingroup periphery |
| 46 |
*/ |
| 47 |
|
| 48 |
/** |
| 49 |
* @defgroup lld_compass Hmc5883l (Compass) |
| 50 |
* @details Compass Documentation |
| 51 |
* @ingroup periphery |
| 52 |
*/ |
| 53 |
|
| 54 |
/** |
| 55 |
* @defgroup lld_power Ina219 (Power Monitor) |
| 56 |
* @details Power Monitor Documentation |
| 57 |
* @ingroup periphery |
| 58 |
*/ |
| 59 |
|
| 60 |
/** |
| 61 |
* @defgroup lld_gyroscope L3g4200d (Gyroscope) |
| 62 |
* @details Gyroscope Documentation |
| 63 |
* @ingroup periphery |
| 64 |
*/ |
| 65 |
|
| 66 |
/** |
| 67 |
* @defgroup lld_led Led |
| 68 |
* @details Led Documentation |
| 69 |
* @ingroup periphery |
| 70 |
*/ |
| 71 |
|
| 72 |
/** |
| 73 |
* @defgroup lld_accel Lis331dlh (Accelerometer) |
| 74 |
* @details Accelerometer Documentation |
| 75 |
* @ingroup periphery |
| 76 |
*/ |
| 77 |
|
| 78 |
/** |
| 79 |
* @defgroup lld_powerpath Ltc4412 (PowerPath Controller) |
| 80 |
* @details PowerPath Controller Documentation |
| 81 |
* @ingroup periphery |
| 82 |
*/ |
| 83 |
|
| 84 |
/** |
| 85 |
* @defgroup lld_touch Mpr121 (Touch Sensor) |
| 86 |
* @details Touch Sensor Documentation |
| 87 |
* @ingroup periphery |
| 88 |
*/ |
| 89 |
|
| 90 |
/** |
| 91 |
* @defgroup lld_multi Pca9544a (I2C Multiplexer) |
| 92 |
* @details I2C Multiplexer Documentation |
| 93 |
* @ingroup periphery |
| 94 |
*/ |
| 95 |
|
| 96 |
/** |
| 97 |
* @defgroup lld_buzzer Pklcs1212e4001 (Buzzer) |
| 98 |
* @details Buzzer Documentation |
| 99 |
* @ingroup periphery |
| 100 |
*/ |
| 101 |
|
| 102 |
/** |
| 103 |
* @defgroup lld_leddriver Tlc5947 (LED Driver) |
| 104 |
* @details LED Driver Documentation |
| 105 |
* @ingroup periphery |
| 106 |
*/ |
| 107 |
|
| 108 |
/** |
| 109 |
* @defgroup lld_switch Tps2051bdbv (Power-Distribution Switch) |
| 110 |
* @details Power-Distribution Switch Documentation |
| 111 |
* @ingroup periphery |
| 112 |
*/ |
| 113 |
|
| 114 |
/** |
| 115 |
* @defgroup lld_stepdown Tps62113 (Step-Down Converter) |
| 116 |
* @details Step-Down Converter Documentation |
| 117 |
* @ingroup periphery |
| 118 |
*/ |
| 119 |
|
| 120 |
/** |
| 121 |
* @defgroup lld_proximity Vcnl4020 (Proximity Sensor) |
| 122 |
* @details Proximity Sensor Documentation |
| 123 |
* @ingroup periphery |
| 124 |
*/ |