diff options
| author | roccomarco <roccomarco@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2017-07-01 13:00:39 +0000 |
|---|---|---|
| committer | roccomarco <roccomarco@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2017-07-01 13:00:39 +0000 |
| commit | fb3c3f45c7a22fe7dcf42a91de4f34ec0c8a1af5 (patch) | |
| tree | 199d482e93880009bfe788bf746e1102193b22f7 /doc/ex/src | |
| parent | abd118ef2d74d46717a95f0c3309237fc3c1f170 (diff) | |
| download | ChibiOS-fb3c3f45c7a22fe7dcf42a91de4f34ec0c8a1af5.tar.gz ChibiOS-fb3c3f45c7a22fe7dcf42a91de4f34ec0c8a1af5.tar.bz2 ChibiOS-fb3c3f45c7a22fe7dcf42a91de4f34ec0c8a1af5.zip | |
Adding ChibiOS/EX documentation (still incomplete)
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@10268 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'doc/ex/src')
| -rw-r--r-- | doc/ex/src/main.dox | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/doc/ex/src/main.dox b/doc/ex/src/main.dox new file mode 100644 index 000000000..fac2d62e7 --- /dev/null +++ b/doc/ex/src/main.dox @@ -0,0 +1,42 @@ +/*
+ ChibiOS - Copyright (C) 2006..2017 Giovanni Di Sirio.
+
+ This file is part of ChibiOS.
+
+ ChibiOS is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 3 of the License, or
+ (at your option) any later version.
+
+ ChibiOS is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+
+/**
+ * @mainpage Introduction
+ * @author Giovanni Di Sirio (gdisirio@users.sourceforge.net).
+ * @author Rocco Marco Guglielmi (guglielmir@playembedded.org).
+ *
+ * <h2>Features</h2>
+ * - EXternal devices (EX) supporting numerous devices external to the MCU
+ * abstracting common devices which are part of modern embedded systems.
+ * - EX resides on top of HAL which offers, among others, a set of abstract
+ * interfaces like Generic Sensor, Gyroscope, Magnetometer, Accelerometer,
+ * Barometer, Thermometer: EX offers a phisical implementation of them.
+ * - Currently STMicroelectronics supported devices are:
+ * - @b HTS221: Capacitive digital humidity sensor;
+ * - @b L3GD20: 3-axis digital gyroscope;
+ * - @b LIS3DSH: 3-axis digital motion sensor;
+ * - @b LIS3MDL: Ultra low power, high performances 3-axis magnetometer;
+ * - @b LIS302DL: 3-axis motion sensor;
+ * - @b LPS25H: Piezoresistive 260-1260 hPa pressure sensor;
+ * - @b LSM6DS0: 6-axis iNEMO inertial module;
+ * - @b LSM303DLHC: Ultra compact high performance e-compass;
+ * - Currently Micron Technology supported devices are:
+ * - @b M25Q: Serial NOR Flash;
+ */
|