groups.md: changed file style from code to markdown

Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu 2016-09-21 14:00:05 -07:00
parent 5df0fe8836
commit c66247b3d3

View File

@ -1,484 +1,398 @@
/* Authors: Brendan Le Foll <brendan.le.foll@intel.com>
* Author: Brendan Le Foll <brendan.le.foll@intel.com> Mihai Tudor Panu <mihai.tudor.panu@intel.com>
* Contributions: Mihai Tudor Panu <mihai.tudor.panu@intel.com> Copyright (c) 2014-2016 Intel Corporation.
* Copyright (c) 2014 Intel Corporation.
* Permission is hereby granted, free of charge, to any person obtaining
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the
* a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including
* "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish,
* without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
* distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to
* permit persons to whom the Software is furnished to do so, subject to the following conditions:
* the following conditions:
* The above copyright notice and this permission notice shall be
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
* included in all copies or substantial portions of the Software.
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
### Notice: ###
/// @cond DEV
/**
* This file only serves to describe sensor groups based on libmraa groups. This file only serves to describe sensor groups based on various filters.
* Sensors may belong to multiple groups. This is purely a documentation header Sensors may belong to multiple groups. This is purely a documentation stub
* and is not meant to be installed anywhere. and is not meant to be installed anywhere.
*/
/// @endcond DEV
### Main group place holders ###
////////////////////////////////////////////////////////////////// @cond HEA
/// Main group place holders.
////////////////////////////////////////////////////////////////// @endcond HEA @defgroup bycat Sensor Categories
@brief Sensors grouped by category
/**
* @brief Sensors grouped by category
* @defgroup bycat Sensor Categories @defgroup byif C++ Interface
*/ @brief Sensors grouped by C++ interface
/**
* @brief Sensors grouped by C++ interface @defgroup bycon Connection Type
* @defgroup byif C++ Interface @brief Sensors grouped by connection type
*/
/** @defgroup byman Manufacturer
* @brief Sensors grouped by connection type @brief Sensors grouped by manufacturer
* @defgroup bycon Connection Type
*/
@defgroup bykit Starter Kits
/** @brief Sensors grouped into starter kits
* @brief Sensors grouped by manufacturer
* @defgroup byman Manufacturer
*/ ### Groups for the various Sensor Categories ###
/**
* @brief Sensors grouped into starter kits @defgroup accelerometer Accelerometer
* @defgroup bykit Starter Kits @ingroup bycat
*/ @brief Measure acceleration & tilt or collision detection
////////////////////////////////////////////////////////////////// @cond CAT
/// Groups for the various Sensor Categories. @defgroup ainput Analog Inputs
////////////////////////////////////////////////////////////////// @endcond CAT @ingroup bycat
@brief Sensors with a variable voltage output
/**
* @brief Measure acceleration & tilt or collision detection
* @defgroup accelerometer Accelerometer @defgroup pressure Atmospheric Pressure
* @ingroup bycat @ingroup bycat
*/ @brief Measure pressure and atmospheric conditions
/**
* @brief Sensors with a variable voltage output @defgroup button Button
* @defgroup ainput Analog Inputs @ingroup bycat
* @ingroup bycat @brief Button, Switch or Toggle
*/
/** @defgroup color Color Sensor
* @brief Measure pressure and atmospheric conditions @ingroup bycat
* @defgroup pressure Atmospheric Pressure @brief Light sensors with special function: Color recognition
* @ingroup bycat
*/
@defgroup compass Compass/Gyro/Magnometers
/** @ingroup bycat
* @brief Button, Switch or Toggle @brief Measure magnetic field to give rotation or heading
* @defgroup button Button
* @ingroup bycat
*/ @defgroup digipot Digital Potentiometer
@ingroup bycat
/** @brief Resistive digital to analog converters (DAC)
* @brief Light sensors with special function: Color recognition
* @defgroup color Color Sensor
* @ingroup bycat @defgroup display Displays
*/ @ingroup bycat
@brief TFT, LCD, LED display elements
/**
* @brief Measure magnetic field to give rotation or heading
* @defgroup compass Compass/Gyro/Magnometers @defgroup electric Electricity
* @ingroup bycat @ingroup bycat
*/ @brief Measure electric current and ADC converters
/**
* @brief Resistive digital to analog converters (DAC) @defgroup flexfor Flex/Force
* @defgroup digipot Digital Potentiometer @ingroup bycat
* @ingroup bycat @brief Measure bending or detect vibration
*/
/** @defgroup gaseous Gas
* @brief TFT, LCD, LED display elements @ingroup bycat
* @defgroup display Displays @brief Measure substance concentrations in gases
* @ingroup bycat
*/
@defgroup gps GPS
/** @ingroup bycat
* @brief Measure electric current and ADC converters @brief Provide positioning capabilities
* @defgroup electric Electricity
* @ingroup bycat
*/ @defgroup led LEDs
@ingroup bycat
/** @brief LEDs, LED strips, LED matrix displays & controllers
* @brief Measure bending or detect vibration
* @defgroup flexfor Flex/Force
* @ingroup bycat @defgroup light Light/Proximity/IR
*/ @ingroup bycat
@brief Measure light intensity or distances
/**
* @brief Measure substance concentrations in gases
* @defgroup gaseous Gas @defgroup liquid Liquid Flow
* @ingroup bycat @ingroup bycat
*/ @brief Measure liquid flow rates or levels
/**
* @brief Provide positioning capabilities @defgroup medical Medical
* @defgroup gps GPS @ingroup bycat
* @ingroup bycat @brief Sensors with specific medical application
*/
/** @defgroup motor Motor
* @brief LEDs, LED strips, LED matrix displays & controllers @ingroup bycat
* @defgroup led LEDs @brief Various motors & controllers to get things moving
* @ingroup bycat
*/
@defgroup other Other
/** @ingroup bycat
* @brief Measure light intensity or distances @brief Other types of supported sensors
* @defgroup light Light/Proximity/IR
* @ingroup bycat
*/ @defgroup relay Relay
@ingroup bycat
/** @brief Different low and high power relays
* @brief Measure liquid flow rates or levels
* @defgroup liquid Liquid Flow
* @ingroup bycat @defgroup rfid RFID
*/ @ingroup bycat
@brief Wireless sensors using RFID tags
/**
* @brief Sensors with specific medical application
* @defgroup medical Medical @defgroup servos Servo
* @ingroup bycat @ingroup bycat
*/ @brief Various servo motors & controllers
/**
* @brief Various motors & controllers to get things moving @defgroup sound Sound
* @defgroup motor Motor @ingroup bycat
* @ingroup bycat @brief Provide sound recording or playback
*/
/** @defgroup temp Temperature/Humidity
* @brief Other types of supported sensors @ingroup bycat
* @defgroup other Other @brief Measure temperature & humidity
* @ingroup bycat
*/
@defgroup serial Serial
/** @ingroup bycat
* @brief Different low and high power relays @brief Sensors using serial communication
* @defgroup relay Relay
* @ingroup bycat
*/ @defgroup time Time
@ingroup bycat
/** @brief Real time clocks & time measurement
* @brief Wireless sensors using RFID tags
* @defgroup rfid RFID
* @ingroup bycat @defgroup touch Touch Sensor
*/ @ingroup bycat
@brief Capacitive touch sensors
/**
* @brief Various servo motors & controllers
* @defgroup servos Servo @defgroup video Video
* @ingroup bycat @ingroup bycat
*/ @brief Provide video or video camera access
/**
* @brief Provide sound recording or playback @defgroup wifi Wireless Communication
* @defgroup sound Sound @ingroup bycat
* @ingroup bycat @brief Provide WiFi, Bluetooth, RF communication
*/
/** ### Groups for the various Sensor C++ Interfaces ###
* @brief Measure temperature & humidity
* @defgroup temp Temperature/Humidity
* @ingroup bycat @defgroup ilightsensor ILightSensor
*/ @ingroup byif
@brief Implements ILightSensor
/**
* @brief Sensors using serial communication
* @defgroup serial Serial @defgroup ilightcontroller ILightController
* @ingroup bycat @ingroup byif
*/ @brief Implements ILightController
/**
* @brief Real time clocks & time measurement @defgroup ipressuresensor IPressureSensor
* @defgroup time Time @ingroup byif
* @ingroup bycat @brief Implements IPressureSensor
*/
/** @defgroup itemperaturesensor ITemperatureSensor
* @brief Capacitive touch sensors @ingroup byif
* @defgroup touch Touch Sensor @brief Implements ITemperatureSensor
* @ingroup bycat
*/
@defgroup iadc IADC
/** @ingroup byif
* @brief Provide video or video camera access @brief Implements IADC
* @defgroup video Video
* @ingroup bycat
*/ @defgroup ico2sensor ICOSensor
@ingroup byif
/** @brief Implements ICOSensor
* @brief Provide WiFi, Bluetooth, RF communication
* @defgroup wifi Wireless Communication
* @ingroup bycat ### Groups for the various Connection Types ###
*/
////////////////////////////////////////////////////////////////// @cond IF @defgroup analog AIO
/// Groups for the various Sensor C++ Interfaces. @ingroup bycon
////////////////////////////////////////////////////////////////// @endcond IF @brief Sensors requiring an ADC value to be read
/**
* @brief Implements ILightSensor @defgroup i2c I2C
* @defgroup ilightsensor ILightSensor @ingroup bycon
* @ingroup byif @brief Modules using the i2c bus
*/
/** @defgroup spi SPI
* @brief Implements ILightController @ingroup bycon
* @defgroup ilightcontroller ILightController @brief Modules using the SPI bus
* @ingroup byif
*/
@defgroup gpio GPIO
/** @ingroup bycon
* @brief Implements IPressureSensor @brief Modules using GPIOs directly
* @defgroup ipressuresensor IPressureSensor
* @ingroup byif
*/ @defgroup pwm PWM
@ingroup bycon
/** @brief Modules using a PWM capable GPIO pin
* @brief Implements ITemperatureSensor
* @defgroup itemperaturesensor ITemperatureSensor
* @ingroup byif @defgroup uart UART
*/ @ingroup bycon
@brief Modules using a serial connection (RX/TX)
/**
* @brief Implements IADC
* @defgroup iadc IADC ### Groups for the various Manufacturers ###
* @ingroup byif
*/
@defgroup adafruit Adafruit
/** @ingroup byman
* @brief Implements ICOSensor @brief Adafruit Industries
* @defgroup ico2sensor ICOSensor
* @ingroup byif
*/ @defgroup emax EMax
@ingroup byman
@brief EMax
////////////////////////////////////////////////////////////////// @cond CON
/// Groups for the various Connection Types.
////////////////////////////////////////////////////////////////// @endcond CON @defgroup dfrobot DFRobot
@ingroup byman
/** @brief DFRobot
* @brief Sensors requiring an ADC value to be read
* @defgroup analog AIO
* @ingroup bycon @defgroup comet Comet
*/ @ingroup byman
@brief Comet System
/**
* @brief Modules using the i2c bus
* @defgroup i2c I2C @defgroup epict EpicTinker
* @ingroup bycon @ingroup byman
*/ @brief EpicTinker
/**
* @brief Modules using the SPI bus @defgroup freescale Freescale
* @defgroup spi SPI @ingroup byman
* @ingroup bycon @brief Freescale
*/
/** @defgroup generic Generic
* @brief Modules using GPIOs directly @ingroup byman
* @defgroup gpio GPIO @brief Generic Brands
* @ingroup bycon
*/
@defgroup honeywell Honeywell
/** @ingroup byman
* @brief Modules using a PWM capable GPIO pin @brief Honeywell
* @defgroup pwm PWM
* @ingroup bycon
*/ @defgroup maxim Maxim Integrated
@ingroup byman
/** @brief Maxim Integrated
* @brief Modules using a serial connection (RX/TX)
* @defgroup uart UART
* @ingroup bycon @defgroup numatolabs Numato Labs
*/ @ingroup byman
@brief Numato Labs
/**
* @brief Modules using Firmata over serial
* @defgroup firmata Firmata @defgroup mouser Mouser
* @ingroup bycon @ingroup byman
*/ @brief Mouser
////////////////////////////////////////////////////////////////// @cond MAN
/// Groups for the various Manufacturers. @defgroup omega Omega
////////////////////////////////////////////////////////////////// @endcond MAN @ingroup byman
@brief Omega
/**
* @brief Adafruit Industries
* @defgroup adafruit Adafruit @defgroup seeed SeeedStudio
* @ingroup byman @ingroup byman
*/ @brief SeeedStudio - Grove Sensors
/**
* @brief EMax @defgroup sparkfun Sparkfun
* @defgroup emax EMax @ingroup byman
* @ingroup byman @brief Sparkfun
*/
/** @defgroup ti Texas Instruments
* @brief DFRobot @ingroup byman
* @defgroup dfrobot DFRobot @brief Texas Instruments
* @ingroup byman
*/
@defgroup veris Veris Industries
/** @ingroup byman
* @brief Comet System @brief Veris Industries
* @defgroup comet Comet
* @ingroup byman
*/ @defgroup silabs Silicon Labs
@ingroup byman
/** @brief Silicon Labs
* @brief EpicTinker
* @defgroup epict EpicTinker
* @ingroup byman @defgroup bosch Bosch
*/ @ingroup byman
@brief Bosch
/**
* @brief Freescale
* @defgroup freescale Freescale @defgroup amphenol Amphenol
* @ingroup byman @ingroup byman
*/ @brief Amphenol
/**
* @brief Generic Brands @defgroup openelectrons Open Electrons
* @defgroup generic Generic @ingroup byman
* @ingroup byman @brief Open Electrons
*/
/** @defgroup meas Measurement Specialties
* @brief Honeywell @ingroup byman
* @defgroup honeywell Honeywell @brief Measurement Specialties
* @ingroup byman
*/
### Groups for the various Starter Kits ###
/**
* @brief Maxim Integrated
* @defgroup maxim Maxim Integrated @defgroup gsk Grove Starter Kit
* @ingroup byman @ingroup bykit
*/ @brief Grove Starter Kit - Contains basic sensors
/**
* @brief Numato Labs @defgroup hak Home Automation Kit
* @defgroup numatolabs Numato Labs @ingroup bykit
* @ingroup byman @brief Home Automation Kit - For projects around the house
*/
/** @defgroup eak Environment & Agriculture Kit
* @brief Mouser @ingroup bykit
* @defgroup mouser Mouser @brief Environment & Agriculture Kit - For outdoor projects
* @ingroup byman
*/
@defgroup tsk Transportation & Safety Kit
/** @ingroup bykit
* @brief Omega @brief Transportation & Safety Kit - Used mostly on vehicles
* @defgroup omega Omega
* @ingroup byman
*/ @defgroup robok Robotics Kit
@ingroup bykit
/** @brief Robotics Kit - Sensors for your robot
* @brief SeeedStudio - Grove Sensors
* @defgroup seeed SeeedStudio
* @ingroup byman
*/
/**
* @brief Sparkfun
* @defgroup sparkfun Sparkfun
* @ingroup byman
*/
/**
* @brief Texas Instruments
* @defgroup ti Texas Instruments
* @ingroup byman
*/
/**
* @brief Veris Industries
* @defgroup veris Veris Industries
* @ingroup byman
*/
/**
* @brief Silicon Labs
* @defgroup silabs Silicon Labs
* @ingroup byman
*/
/**
* @brief Bosch
* @defgroup bosch Bosch
* @ingroup byman
*/
/**
* @brief Amphenol
* @defgroup amphenol Amphenol
* @ingroup byman
*/
/**
* @brief Open Electrons
* @defgroup openelectrons Open Electrons
* @ingroup byman
*/
/**
* @brief Measurement Specialties
* @defgroup meas Measurement Specialties
* @ingroup byman
*/
////////////////////////////////////////////////////////////////// @cond KIT
/// Groups for the various Starter Kits.
////////////////////////////////////////////////////////////////// @endcond KIT
/**
* @brief Grove Starter Kit - Contains basic sensors
* @defgroup gsk Grove Starter Kit
* @ingroup bykit
*/
/**
* @brief Home Automation Kit - For projects around the house
* @defgroup hak Home Automation Kit
* @ingroup bykit
*/
/**
* @brief Environment & Agriculture Kit - For outdoor projects
* @defgroup eak Environment & Agriculture Kit
* @ingroup bykit
*/
/**
* @brief Transportation & Safety Kit - Used mostly on vehicles
* @defgroup tsk Transportation & Safety Kit
* @ingroup bykit
*/
/**
* @brief Robotics Kit - Sensors for your robot
* @defgroup robok Robotics Kit
* @ingroup bykit
*/