From 223b6028bf6163b39989e3edea382416e113579c Mon Sep 17 00:00:00 2001 From: Mihai Tudor Panu Date: Thu, 4 Apr 2019 17:21:07 -0700 Subject: [PATCH] 2jciebu01: update documentation tags, dependencies, library names Signed-off-by: Mihai Tudor Panu --- src/2jciebu01-ble/2jciebu01_ble.hpp | 64 ++++++++++++++--------------- src/2jciebu01-ble/CMakeLists.txt | 8 ++-- src/2jciebu01-usb/2jciebu01.hpp | 25 ++--------- src/2jciebu01-usb/2jciebu01_usb.hpp | 62 ++++++++++++++-------------- src/2jciebu01-usb/CMakeLists.txt | 10 ++--- src/groups.md | 11 ++++- 6 files changed, 83 insertions(+), 97 deletions(-) diff --git a/src/2jciebu01-ble/2jciebu01_ble.hpp b/src/2jciebu01-ble/2jciebu01_ble.hpp index ede85a3a..2dd60b6b 100644 --- a/src/2jciebu01-ble/2jciebu01_ble.hpp +++ b/src/2jciebu01-ble/2jciebu01_ble.hpp @@ -1,25 +1,24 @@ /* -* -* Author: Hiroyuki Mino -* Copyright (c) 2019 Omron Electronic Components - Americas -* -* Permission is hereby granted, free of charge, to any person obtaining a copy of -* this software and associated documentation files (the "Software"), to deal in -* the Software without restriction, including without limitation the rights to -* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of -* the Software, and to permit persons to whom the Software is furnished to do so, -* subject to the following conditions: -* -* The above copyright notice and this permission notice shall be included in all -* copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS -* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR -* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER -* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN -* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*/ + * Author: Hiroyuki Mino + * Copyright (c) 2019 Omron Electronic Components - Americas + * + * Permission is hereby granted, free of charge, to any person obtaining a copy of + * this software and associated documentation files (the "Software"), to deal in + * the Software without restriction, including without limitation the rights to + * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of + * the Software, and to permit persons to whom the Software is furnished to do so, + * subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS + * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR + * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER + * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN + * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + */ /*=========================================================================*/ @@ -34,7 +33,7 @@ #include #include #include -#include "../2jciebu01.hpp" +#include "2jciebu01.hpp" /*MACROS and enum */ @@ -57,26 +56,25 @@ namespace upm { /** - * @brief 2JCIEBU01 Environment sensor - * @defgroup 2jciebu01 libupm-2jciebu01_ble - * @ingroup Omron USB type + * @brief 2JCIEBU01 BLE Environment Sensor + * @defgroup 2jciebu01-ble libupm-2jciebu01-ble + * @ingroup omron ble accelerometer pressure sound flexfor */ /** - * @library libupm-2jciebu01_ble - * @sensor 2jciebu01 - * @comname Environment Sensor Module - * @altname Omron Environment sensor USB type - * @type USB - * @man Omron - * @web https://www.components.omron.com/solutions/mems-sensors/environment-sensor + * @library 2jciebu01-ble + * @sensor 2jciebu01-ble + * @comname Omron BLE Environment Sensor Module + * @type accelerometer pressure sound flexfor + * @man omron * @con ble + * @web https://www.components.omron.com/solutions/mems-sensors/environment-sensor * * @brief API for the Omron USB type environment Sensor Module using BLE interface * * It is connected via a BLE Interface * - * @snippet 2jciebu01_ble.cxx Interesting + * @snippet 2jciebu01-ble.cxx Interesting */ class OM2JCIEBU_BLE : public OM2JCIEBU { diff --git a/src/2jciebu01-ble/CMakeLists.txt b/src/2jciebu01-ble/CMakeLists.txt index 015c5514..a07f57d3 100644 --- a/src/2jciebu01-ble/CMakeLists.txt +++ b/src/2jciebu01-ble/CMakeLists.txt @@ -1,5 +1,5 @@ -set (libname "2jciebu01_ble") -set (libdescription "Omron Environment Sensor") -set (module_src ${libname}.cxx "2jciebu01.cxx") -set (module_hpp ${libname}.hpp "2jciebu01.hpp") +set (libname "2jciebu01-ble") +set (libdescription "Omron BLE Environment Sensor") +set (module_src "2jciebu01_ble.cxx") +set (module_hpp "2jciebu01_ble.hpp") upm_module_init(2jciebu01-usb) diff --git a/src/2jciebu01-usb/2jciebu01.hpp b/src/2jciebu01-usb/2jciebu01.hpp index b12dc09d..6bd12cf2 100644 --- a/src/2jciebu01-usb/2jciebu01.hpp +++ b/src/2jciebu01-usb/2jciebu01.hpp @@ -39,9 +39,6 @@ #include -#include - - /*MACROS and enum */ @@ -67,26 +64,10 @@ namespace upm { /** - * @brief omron 2JCIEBU01 Environment sensor - * @defgroup 2jciebu01 libupm-2jciebu01 - * @ingroup Omron USB type - */ - -/** - * @library 2jciebu01 - * @sensor 2jciebu01 - * @comname Environment Sensor Module - * @altname Omron Environment sensor USB type - * @type USB - * @man Omron - * @web https://www.components.omron.com/solutions/mems-sensors/environment-sensor - * @con usb + * @class OM2JCIEBU + * @brief Base class for Omron 2JCIEBU Sensors * - * @brief API for the Omron USB type environment Sensor Module using USB to UART interface - * - * It is connected via a UART at 115200 baud. - * - * @snippet 2jciebu01.cxx Interesting + * Implements common functionality for the Omron 2JCIEBU USB and BLE Sensors */ class OM2JCIEBU { diff --git a/src/2jciebu01-usb/2jciebu01_usb.hpp b/src/2jciebu01-usb/2jciebu01_usb.hpp index 745d9fd2..aa18490a 100644 --- a/src/2jciebu01-usb/2jciebu01_usb.hpp +++ b/src/2jciebu01-usb/2jciebu01_usb.hpp @@ -1,25 +1,24 @@ /* -* -* Author: Hiroyuki Mino -* Copyright (c) 2019 Omron Electronic Components - Americas -* -* Permission is hereby granted, free of charge, to any person obtaining a copy of -* this software and associated documentation files (the "Software"), to deal in -* the Software without restriction, including without limitation the rights to -* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of -* the Software, and to permit persons to whom the Software is furnished to do so, -* subject to the following conditions: -* -* The above copyright notice and this permission notice shall be included in all -* copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS -* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR -* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER -* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN -* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*/ + * Author: Hiroyuki Mino + * Copyright (c) 2019 Omron Electronic Components - Americas + * + * Permission is hereby granted, free of charge, to any person obtaining a copy of + * this software and associated documentation files (the "Software"), to deal in + * the Software without restriction, including without limitation the rights to + * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of + * the Software, and to permit persons to whom the Software is furnished to do so, + * subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS + * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR + * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER + * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN + * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + */ /*=========================================================================*/ @@ -52,26 +51,25 @@ namespace upm { /** - * @brief 2JCIEBU01 Environment sensor - * @defgroup 2jciebu01 libupm-2jciebu01_usb - * @ingroup Omron USB type + * @brief 2JCIEBU01 USB Environment Sensor + * @defgroup 2jciebu01-usb libupm-2jciebu01-usb + * @ingroup omron uart accelerometer pressure sound flexfor */ /** - * @library libupm-2jciebu01_usb - * @sensor 2jciebu01 - * @comname Environment Sensor Module - * @altname Omron Environment sensor USB type - * @type USB - * @man Omron + * @library 2jciebu01-usb + * @sensor 2jciebu01-usb + * @comname Omron USB Environment Sensor Module + * @type accelerometer pressure sound flexfor + * @man omron + * @con uart * @web https://www.components.omron.com/solutions/mems-sensors/environment-sensor - * @con usb * * @brief API for the Omron USB type environment Sensor Module using USB to UART interface * * It is connected via a UART at 115200 baud. * - * @snippet 2jciebu01_usb.cxx Interesting + * @snippet 2jciebu01-usb.cxx Interesting */ class OM2JCIEBU_UART : public OM2JCIEBU { diff --git a/src/2jciebu01-usb/CMakeLists.txt b/src/2jciebu01-usb/CMakeLists.txt index 0bf5af94..682b4a15 100644 --- a/src/2jciebu01-usb/CMakeLists.txt +++ b/src/2jciebu01-usb/CMakeLists.txt @@ -1,5 +1,5 @@ -set (libname "2jciebu01_usb") -set (libdescription "Omron Environment Sensor") -set (module_src ${libname}.cxx "2jciebu01.cxx") -set (module_hpp ${libname}.hpp "2jciebu01.hpp") -upm_module_init(mraa utilities-c) +set (libname "2jciebu01-usb") +set (libdescription "Omron USB Environment Sensor") +set (module_src "2jciebu01_usb.cxx" "2jciebu01.cxx") +set (module_hpp "2jciebu01_usb.hpp" "2jciebu01.hpp") +upm_module_init(mraa) diff --git a/src/groups.md b/src/groups.md index f49c0e9e..14e5a718 100644 --- a/src/groups.md +++ b/src/groups.md @@ -240,6 +240,11 @@ and is not meant to be installed anywhere. @brief Sensors requiring an ADC value to be read +@defgroup ble BLE +@ingroup bycon +@brief Modules using a Bluetooth Low Energy connection + + @defgroup i2c I2C @ingroup bycon @brief Modules using the i2c bus @@ -264,7 +269,6 @@ and is not meant to be installed anywhere. @ingroup bycon @brief Modules using a serial connection (RX/TX) - ### Groups for the various Manufacturers ### @@ -353,6 +357,11 @@ and is not meant to be installed anywhere. @brief Omega +@defgroup omron Omron +@ingroup byman +@brief Omron + + @defgroup openelectrons Open Electrons @ingroup byman @brief Open Electrons