alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-03-14 20:47:30 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

2jciebu01: update documentation tags, dependencies, library names

Browse Source 
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu 2019-04-04 17:21:07 -07:00
parent b08eef0197
commit 223b6028bf
6 changed files with 83 additions and 97 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
src/2jciebu01-ble/2jciebu01_ble.hpp
View File

@ -1,25 +1,24 @@
/* /*
* * Author: Hiroyuki Mino <omronsupportupm@omron.com>
* Author: Hiroyuki Mino <omronsupportupm@omron.com> * Copyright (c) 2019 Omron Electronic Components - Americas
* Copyright (c) 2019 Omron Electronic Components - Americas *
* * Permission is hereby granted, free of charge, to any person obtaining a copy of
* 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
* this software and associated documentation files (the "Software"), to deal in * the Software without restriction, including without limitation the rights to
* the Software without restriction, including without limitation the rights to * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
* 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,
* the Software, and to permit persons to whom the Software is furnished to do so, * subject to the following conditions:
* subject to the following conditions: *
* * The above copyright notice and this permission notice shall be included in all
* The above copyright notice and this permission notice shall be included in all * copies or substantial portions of the Software.
* copies or substantial portions of the Software. *
* * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* 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
* 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
* 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.
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
*/
/*=========================================================================*/ /*=========================================================================*/
@ -34,7 +33,7 @@
#include <thread> #include <thread>
#include <atomic> #include <atomic>
#include <csignal> #include <csignal>
#include "../2jciebu01.hpp" #include "2jciebu01.hpp"
/*MACROS and enum */ /*MACROS and enum */
@ -57,26 +56,25 @@
namespace upm namespace upm
{ {
/** /**
* @brief 2JCIEBU01 Environment sensor * @brief 2JCIEBU01 BLE Environment Sensor
* @defgroup 2jciebu01 libupm-2jciebu01_ble * @defgroup 2jciebu01-ble libupm-2jciebu01-ble
* @ingroup Omron USB type * @ingroup omron ble accelerometer pressure sound flexfor
*/ */
/** /**
* @library libupm-2jciebu01_ble * @library 2jciebu01-ble
* @sensor 2jciebu01 * @sensor 2jciebu01-ble
* @comname Environment Sensor Module * @comname Omron BLE Environment Sensor Module
* @altname Omron Environment sensor USB type * @type accelerometer pressure sound flexfor
* @type USB * @man omron
* @man Omron
* @web https://www.components.omron.com/solutions/mems-sensors/environment-sensor
* @con ble * @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 * @brief API for the Omron USB type environment Sensor Module using BLE interface
* *
* It is connected via a BLE Interface * It is connected via a BLE Interface
* *
* @snippet 2jciebu01_ble.cxx Interesting * @snippet 2jciebu01-ble.cxx Interesting
*/ */
class OM2JCIEBU_BLE : public OM2JCIEBU class OM2JCIEBU_BLE : public OM2JCIEBU
{ {

8
src/2jciebu01-ble/CMakeLists.txt
View File

@ -1,5 +1,5 @@
set (libname "2jciebu01_ble") set (libname "2jciebu01-ble")
set (libdescription "Omron Environment Sensor") set (libdescription "Omron BLE Environment Sensor")
set (module_src ${libname}.cxx "2jciebu01.cxx") set (module_src "2jciebu01_ble.cxx")
set (module_hpp ${libname}.hpp "2jciebu01.hpp") set (module_hpp "2jciebu01_ble.hpp")
upm_module_init(2jciebu01-usb) upm_module_init(2jciebu01-usb)

25
src/2jciebu01-usb/2jciebu01.hpp
View File

@ -39,9 +39,6 @@
#include <sys/stat.h> #include <sys/stat.h>
#include <upm/upm_utilities.h>
/*MACROS and enum */ /*MACROS and enum */
@ -67,26 +64,10 @@
namespace upm namespace upm
{ {
/** /**
* @brief omron 2JCIEBU01 Environment sensor * @class OM2JCIEBU
* @defgroup 2jciebu01 libupm-2jciebu01 * @brief Base class for Omron 2JCIEBU Sensors
* @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
* *
* @brief API for the Omron USB type environment Sensor Module using USB to UART interface * Implements common functionality for the Omron 2JCIEBU USB and BLE Sensors
*
* It is connected via a UART at 115200 baud.
*
* @snippet 2jciebu01.cxx Interesting
*/ */
class OM2JCIEBU class OM2JCIEBU
{ {

62
src/2jciebu01-usb/2jciebu01_usb.hpp
View File

@ -1,25 +1,24 @@
/* /*
* * Author: Hiroyuki Mino <omronsupportupm@omron.com>
* Author: Hiroyuki Mino <omronsupportupm@omron.com> * Copyright (c) 2019 Omron Electronic Components - Americas
* Copyright (c) 2019 Omron Electronic Components - Americas *
* * Permission is hereby granted, free of charge, to any person obtaining a copy of
* 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
* this software and associated documentation files (the "Software"), to deal in * the Software without restriction, including without limitation the rights to
* the Software without restriction, including without limitation the rights to * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
* 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,
* the Software, and to permit persons to whom the Software is furnished to do so, * subject to the following conditions:
* subject to the following conditions: *
* * The above copyright notice and this permission notice shall be included in all
* The above copyright notice and this permission notice shall be included in all * copies or substantial portions of the Software.
* copies or substantial portions of the Software. *
* * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* 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
* 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
* 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.
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
*/
/*=========================================================================*/ /*=========================================================================*/
@ -52,26 +51,25 @@
namespace upm namespace upm
{ {
/** /**
* @brief 2JCIEBU01 Environment sensor * @brief 2JCIEBU01 USB Environment Sensor
* @defgroup 2jciebu01 libupm-2jciebu01_usb * @defgroup 2jciebu01-usb libupm-2jciebu01-usb
* @ingroup Omron USB type * @ingroup omron uart accelerometer pressure sound flexfor
*/ */
/** /**
* @library libupm-2jciebu01_usb * @library 2jciebu01-usb
* @sensor 2jciebu01 * @sensor 2jciebu01-usb
* @comname Environment Sensor Module * @comname Omron USB Environment Sensor Module
* @altname Omron Environment sensor USB type * @type accelerometer pressure sound flexfor
* @type USB * @man omron
* @man Omron * @con uart
* @web https://www.components.omron.com/solutions/mems-sensors/environment-sensor * @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 * @brief API for the Omron USB type environment Sensor Module using USB to UART interface
* *
* It is connected via a UART at 115200 baud. * It is connected via a UART at 115200 baud.
* *
* @snippet 2jciebu01_usb.cxx Interesting * @snippet 2jciebu01-usb.cxx Interesting
*/ */
class OM2JCIEBU_UART : public OM2JCIEBU class OM2JCIEBU_UART : public OM2JCIEBU
{ {

10
src/2jciebu01-usb/CMakeLists.txt
View File

@ -1,5 +1,5 @@
set (libname "2jciebu01_usb") set (libname "2jciebu01-usb")
set (libdescription "Omron Environment Sensor") set (libdescription "Omron USB Environment Sensor")
set (module_src ${libname}.cxx "2jciebu01.cxx") set (module_src "2jciebu01_usb.cxx" "2jciebu01.cxx")
set (module_hpp ${libname}.hpp "2jciebu01.hpp") set (module_hpp "2jciebu01_usb.hpp" "2jciebu01.hpp")
upm_module_init(mraa utilities-c) upm_module_init(mraa)

11
src/groups.md
View File

@ -240,6 +240,11 @@ and is not meant to be installed anywhere.
@brief Sensors requiring an ADC value to be read @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 @defgroup i2c I2C
@ingroup bycon @ingroup bycon
@brief Modules using the i2c bus @brief Modules using the i2c bus
@ -264,7 +269,6 @@ and is not meant to be installed anywhere.
@ingroup bycon @ingroup bycon
@brief Modules using a serial connection (RX/TX) @brief Modules using a serial connection (RX/TX)
### Groups for the various Manufacturers ### ### Groups for the various Manufacturers ###
@ -353,6 +357,11 @@ and is not meant to be installed anywhere.
@brief Omega @brief Omega
@defgroup omron Omron
@ingroup byman
@brief Omron
@defgroup openelectrons Open Electrons @defgroup openelectrons Open Electrons
@ingroup byman @ingroup byman
@brief Open Electrons @brief Open Electrons