From fb3c3f45c7a22fe7dcf42a91de4f34ec0c8a1af5 Mon Sep 17 00:00:00 2001 From: roccomarco Date: Sat, 1 Jul 2017 13:00:39 +0000 Subject: Adding ChibiOS/EX documentation (still incomplete) git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@10268 35acf78f-673a-0410-8e92-d51de3d6d3f4 --- doc/ex/src/main.dox | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 doc/ex/src/main.dox (limited to 'doc/ex/src') 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 . +*/ + +/** + * @mainpage Introduction + * @author Giovanni Di Sirio (gdisirio@users.sourceforge.net). + * @author Rocco Marco Guglielmi (guglielmir@playembedded.org). + * + *

Features

+ * - 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; + */ -- cgit v1.2.3