mirror of
https://github.com/eclipse/upm.git
synced 2025-03-14 20:47:30 +03:00
2jciebu01: update documentation tags, dependencies, library names
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu
parent
b08eef0197
commit
223b6028bf
@ -1,25 +1,24 @@
|
||||
/*
|
||||
*
|
||||
* Author: Hiroyuki Mino <omronsupportupm@omron.com>
|
||||
* 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 <omronsupportupm@omron.com>
|
||||
* 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 <thread>
|
||||
#include <atomic>
|
||||
#include <csignal>
|
||||
#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
|
||||
{
|
||||
|
||||
@ -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)
|
||||
|
||||
@ -39,9 +39,6 @@
|
||||
#include <sys/stat.h>
|
||||
|
||||
|
||||
#include <upm/upm_utilities.h>
|
||||
|
||||
|
||||
/*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
|
||||
{
|
||||
|
||||
@ -1,25 +1,24 @@
|
||||
/*
|
||||
*
|
||||
* Author: Hiroyuki Mino <omronsupportupm@omron.com>
|
||||
* 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 <omronsupportupm@omron.com>
|
||||
* 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
|
||||
{
|
||||
|
||||
@ -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)
|
||||
|
||||
@ -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
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user