Skip to content

Commit 223b602

Browse files
PropanuPropanu
committed
2jciebu01: update documentation tags, dependencies, library names
Signed-off-by: Mihai Tudor Panu <[email protected]>
1 parent b08eef0 commit 223b602

File tree

6 files changed

+83
-97
lines changed

6 files changed

+83
-97
lines changed

‎src/2jciebu01-ble/2jciebu01_ble.hpp‎

Lines changed: 31 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,24 @@
11
/*
2-
*
3-
* Author: Hiroyuki Mino <[email protected]>
4-
* Copyright (c) 2019 Omron Electronic Components - Americas
5-
*
6-
* Permission is hereby granted, free of charge, to any person obtaining a copy of
7-
* this software and associated documentation files (the "Software"), to deal in
8-
* the Software without restriction, including without limitation the rights to
9-
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
10-
* the Software, and to permit persons to whom the Software is furnished to do so,
11-
* subject to the following conditions:
12-
*
13-
* The above copyright notice and this permission notice shall be included in all
14-
* copies or substantial portions of the Software.
15-
*
16-
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17-
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
18-
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
19-
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
20-
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
21-
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22-
*/
2+
* Author: Hiroyuki Mino <[email protected]>
3+
* Copyright (c) 2019 Omron Electronic Components - Americas
4+
*
5+
* Permission is hereby granted, free of charge, to any person obtaining a copy of
6+
* this software and associated documentation files (the "Software"), to deal in
7+
* the Software without restriction, including without limitation the rights to
8+
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
9+
* the Software, and to permit persons to whom the Software is furnished to do so,
10+
* subject to the following conditions:
11+
*
12+
* The above copyright notice and this permission notice shall be included in all
13+
* copies or substantial portions of the Software.
14+
*
15+
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
17+
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
18+
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
19+
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20+
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21+
*/
2322

2423
/*=========================================================================*/
2524

@@ -34,7 +33,7 @@
3433
#include <thread>
3534
#include <atomic>
3635
#include <csignal>
37-
#include "../2jciebu01.hpp"
36+
#include "2jciebu01.hpp"
3837

3938
/*MACROS and enum */
4039

@@ -57,26 +56,25 @@
5756
namespace upm
5857
{
5958
/**
60-
* @brief 2JCIEBU01 Environment sensor
61-
* @defgroup 2jciebu01 libupm-2jciebu01_ble
62-
* @ingroup Omron USB type
59+
* @brief 2JCIEBU01 BLE Environment Sensor
60+
* @defgroup 2jciebu01-ble libupm-2jciebu01-ble
61+
* @ingroup omron ble accelerometer pressure sound flexfor
6362
*/
6463

6564
/**
66-
* @library libupm-2jciebu01_ble
67-
* @sensor 2jciebu01
68-
* @comname Environment Sensor Module
69-
* @altname Omron Environment sensor USB type
70-
* @type USB
71-
* @man Omron
72-
* @web https://www.components.omron.com/solutions/mems-sensors/environment-sensor
65+
* @library 2jciebu01-ble
66+
* @sensor 2jciebu01-ble
67+
* @comname Omron BLE Environment Sensor Module
68+
* @type accelerometer pressure sound flexfor
69+
* @man omron
7370
* @con ble
71+
* @web https://www.components.omron.com/solutions/mems-sensors/environment-sensor
7472
*
7573
* @brief API for the Omron USB type environment Sensor Module using BLE interface
7674
*
7775
* It is connected via a BLE Interface
7876
*
79-
* @snippet 2jciebu01_ble.cxx Interesting
77+
* @snippet 2jciebu01-ble.cxx Interesting
8078
*/
8179
class OM2JCIEBU_BLE : public OM2JCIEBU
8280
{

‎src/2jciebu01-ble/CMakeLists.txt‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
set (libname "2jciebu01_ble")
2-
set (libdescription "Omron Environment Sensor")
3-
set (module_src ${libname}.cxx "2jciebu01.cxx")
4-
set (module_hpp ${libname}.hpp "2jciebu01.hpp")
1+
set (libname "2jciebu01-ble")
2+
set (libdescription "Omron BLE Environment Sensor")
3+
set (module_src "2jciebu01_ble.cxx")
4+
set (module_hpp "2jciebu01_ble.hpp")
55
upm_module_init(2jciebu01-usb)

‎src/2jciebu01-usb/2jciebu01.hpp‎

Lines changed: 3 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,6 @@
3939
#include <sys/stat.h>
4040

4141

42-
#include <upm/upm_utilities.h>
43-
44-
4542
/*MACROS and enum */
4643

4744

@@ -67,26 +64,10 @@
6764
namespace upm
6865
{
6966
/**
70-
* @brief omron 2JCIEBU01 Environment sensor
71-
* @defgroup 2jciebu01 libupm-2jciebu01
72-
* @ingroup Omron USB type
73-
*/
74-
75-
/**
76-
* @library 2jciebu01
77-
* @sensor 2jciebu01
78-
* @comname Environment Sensor Module
79-
* @altname Omron Environment sensor USB type
80-
* @type USB
81-
* @man Omron
82-
* @web https://www.components.omron.com/solutions/mems-sensors/environment-sensor
83-
* @con usb
84-
*
85-
* @brief API for the Omron USB type environment Sensor Module using USB to UART interface
86-
*
87-
* It is connected via a UART at 115200 baud.
67+
* @class OM2JCIEBU
68+
* @brief Base class for Omron 2JCIEBU Sensors
8869
*
89-
* @snippet 2jciebu01.cxx Interesting
70+
* Implements common functionality for the Omron 2JCIEBU USB and BLE Sensors
9071
*/
9172
class OM2JCIEBU
9273
{

‎src/2jciebu01-usb/2jciebu01_usb.hpp‎

Lines changed: 30 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,24 @@
11
/*
2-
*
3-
* Author: Hiroyuki Mino <[email protected]>
4-
* Copyright (c) 2019 Omron Electronic Components - Americas
5-
*
6-
* Permission is hereby granted, free of charge, to any person obtaining a copy of
7-
* this software and associated documentation files (the "Software"), to deal in
8-
* the Software without restriction, including without limitation the rights to
9-
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
10-
* the Software, and to permit persons to whom the Software is furnished to do so,
11-
* subject to the following conditions:
12-
*
13-
* The above copyright notice and this permission notice shall be included in all
14-
* copies or substantial portions of the Software.
15-
*
16-
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17-
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
18-
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
19-
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
20-
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
21-
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22-
*/
2+
* Author: Hiroyuki Mino <[email protected]>
3+
* Copyright (c) 2019 Omron Electronic Components - Americas
4+
*
5+
* Permission is hereby granted, free of charge, to any person obtaining a copy of
6+
* this software and associated documentation files (the "Software"), to deal in
7+
* the Software without restriction, including without limitation the rights to
8+
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
9+
* the Software, and to permit persons to whom the Software is furnished to do so,
10+
* subject to the following conditions:
11+
*
12+
* The above copyright notice and this permission notice shall be included in all
13+
* copies or substantial portions of the Software.
14+
*
15+
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
17+
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
18+
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
19+
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20+
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21+
*/
2322

2423
/*=========================================================================*/
2524

@@ -52,26 +51,25 @@
5251
namespace upm
5352
{
5453
/**
55-
* @brief 2JCIEBU01 Environment sensor
56-
* @defgroup 2jciebu01 libupm-2jciebu01_usb
57-
* @ingroup Omron USB type
54+
* @brief 2JCIEBU01 USB Environment Sensor
55+
* @defgroup 2jciebu01-usb libupm-2jciebu01-usb
56+
* @ingroup omron uart accelerometer pressure sound flexfor
5857
*/
5958

6059
/**
61-
* @library libupm-2jciebu01_usb
62-
* @sensor 2jciebu01
63-
* @comname Environment Sensor Module
64-
* @altname Omron Environment sensor USB type
65-
* @type USB
66-
* @man Omron
60+
* @library 2jciebu01-usb
61+
* @sensor 2jciebu01-usb
62+
* @comname Omron USB Environment Sensor Module
63+
* @type accelerometer pressure sound flexfor
64+
* @man omron
65+
* @con uart
6766
* @web https://www.components.omron.com/solutions/mems-sensors/environment-sensor
68-
* @con usb
6967
*
7068
* @brief API for the Omron USB type environment Sensor Module using USB to UART interface
7169
*
7270
* It is connected via a UART at 115200 baud.
7371
*
74-
* @snippet 2jciebu01_usb.cxx Interesting
72+
* @snippet 2jciebu01-usb.cxx Interesting
7573
*/
7674
class OM2JCIEBU_UART : public OM2JCIEBU
7775
{

‎src/2jciebu01-usb/CMakeLists.txt‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
set (libname "2jciebu01_usb")
2-
set (libdescription "Omron Environment Sensor")
3-
set (module_src ${libname}.cxx "2jciebu01.cxx")
4-
set (module_hpp ${libname}.hpp "2jciebu01.hpp")
5-
upm_module_init(mraa utilities-c)
1+
set (libname "2jciebu01-usb")
2+
set (libdescription "Omron USB Environment Sensor")
3+
set (module_src "2jciebu01_usb.cxx" "2jciebu01.cxx")
4+
set (module_hpp "2jciebu01_usb.hpp" "2jciebu01.hpp")
5+
upm_module_init(mraa)

‎src/groups.md‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -240,6 +240,11 @@ and is not meant to be installed anywhere.
240240
@brief Sensors requiring an ADC value to be read
241241

242242

243+
@defgroup ble BLE
244+
@ingroup bycon
245+
@brief Modules using a Bluetooth Low Energy connection
246+
247+
243248
@defgroup i2c I2C
244249
@ingroup bycon
245250
@brief Modules using the i2c bus
@@ -264,7 +269,6 @@ and is not meant to be installed anywhere.
264269
@ingroup bycon
265270
@brief Modules using a serial connection (RX/TX)
266271

267-
268272
### Groups for the various Manufacturers ###
269273

270274

@@ -353,6 +357,11 @@ and is not meant to be installed anywhere.
353357
@brief Omega
354358

355359

360+
@defgroup omron Omron
361+
@ingroup byman
362+
@brief Omron
363+
364+
356365
@defgroup openelectrons Open Electrons
357366
@ingroup byman
358367
@brief Open Electrons

0 commit comments

Comments
 (0)