From 2ec1d70e97d4e9a6c39ada3a242fa75571b318b7 Mon Sep 17 00:00:00 2001 From: Florian Zirker Date: Sun, 16 Dec 2018 17:35:47 +0100 Subject: [PATCH] documentation and clean up --- .clang-format | 132 +++++++++++++++++++-------------------- CMakeLists.txt | 36 ++++------- launch/wlanSignal.launch | 4 +- src/wlanSignal.cpp | 59 ++++++++--------- 4 files changed, 106 insertions(+), 125 deletions(-) diff --git a/.clang-format b/.clang-format index cdcb29d..e519318 100644 --- a/.clang-format +++ b/.clang-format @@ -1,66 +1,66 @@ ---- -BasedOnStyle: Google -AccessModifierOffset: -2 -ConstructorInitializerIndentWidth: 2 -AlignEscapedNewlinesLeft: false -AlignTrailingComments: true -AllowAllParametersOfDeclarationOnNextLine: false -AllowShortIfStatementsOnASingleLine: false -AllowShortLoopsOnASingleLine: false -AllowShortFunctionsOnASingleLine: None -AllowShortLoopsOnASingleLine: false -AlwaysBreakTemplateDeclarations: true -AlwaysBreakBeforeMultilineStrings: false -BreakBeforeBinaryOperators: false -BreakBeforeTernaryOperators: false -BreakConstructorInitializersBeforeComma: true -BinPackParameters: true -ColumnLimit: 120 -ConstructorInitializerAllOnOneLineOrOnePerLine: true -DerivePointerBinding: false -PointerBindsToType: true -ExperimentalAutoDetectBinPacking: false -IndentCaseLabels: true -MaxEmptyLinesToKeep: 1 -NamespaceIndentation: None -ObjCSpaceBeforeProtocolList: true -PenaltyBreakBeforeFirstCallParameter: 19 -PenaltyBreakComment: 60 -PenaltyBreakString: 1 -PenaltyBreakFirstLessLess: 1000 -PenaltyExcessCharacter: 1000 -PenaltyReturnTypeOnItsOwnLine: 90 -SpacesBeforeTrailingComments: 2 -Cpp11BracedListStyle: false -Standard: Auto -IndentWidth: 3 -TabWidth: 3 -UseTab: Never -IndentFunctionDeclarationAfterType: false -SpacesInParentheses: true -SpacesInAngles: false -SpaceInEmptyParentheses: false -SpacesInCStyleCastParentheses: false -SpaceAfterControlStatementKeyword: true -SpaceBeforeAssignmentOperators: true -ContinuationIndentWidth: 4 -SortIncludes: false -SpaceAfterCStyleCast: false - -# Configure each individual brace in BraceWrapping -BreakBeforeBraces: Custom - -# Control of individual brace wrapping cases -BraceWrapping: { - AfterClass: 'true' - AfterControlStatement: 'false' - AfterEnum : 'true' - AfterFunction : 'false' - AfterNamespace : 'true' - AfterStruct : 'true' - AfterUnion : 'true' - BeforeCatch : 'true' - BeforeElse : 'true' - IndentBraces : 'false' -} -... +--- +BasedOnStyle: Google +AccessModifierOffset: -2 +ConstructorInitializerIndentWidth: 2 +AlignEscapedNewlinesLeft: false +AlignTrailingComments: true +AllowAllParametersOfDeclarationOnNextLine: false +AllowShortIfStatementsOnASingleLine: false +AllowShortLoopsOnASingleLine: false +AllowShortFunctionsOnASingleLine: None +AlwaysBreakTemplateDeclarations: true +AlwaysBreakBeforeMultilineStrings: false +BreakBeforeBinaryOperators: false +BreakBeforeTernaryOperators: false +BreakConstructorInitializersBeforeComma: true +BinPackParameters: false +ColumnLimit: 100 +ConstructorInitializerAllOnOneLineOrOnePerLine: true +DerivePointerBinding: false +PointerBindsToType: true +ExperimentalAutoDetectBinPacking: false +IndentCaseLabels: true +MaxEmptyLinesToKeep: 2 +NamespaceIndentation: None +ObjCSpaceBeforeProtocolList: true +PenaltyBreakBeforeFirstCallParameter: 19 +PenaltyBreakComment: 60 +PenaltyBreakString: 1 +PenaltyBreakFirstLessLess: 1000 +PenaltyExcessCharacter: 1000 +PenaltyReturnTypeOnItsOwnLine: 90 +SpacesBeforeTrailingComments: 2 +Cpp11BracedListStyle: false +Standard: Auto +IndentWidth: 3 +TabWidth: 3 +UseTab: Never +IndentFunctionDeclarationAfterType: false +SpacesInParentheses: true +SpacesInAngles: false +SpaceInEmptyParentheses: false +SpacesInCStyleCastParentheses: false +SpaceAfterControlStatementKeyword: true +SpaceBeforeAssignmentOperators: true +ContinuationIndentWidth: 4 +SortIncludes: false +SpaceAfterCStyleCast: false +AlignConsecutiveAssignments: true + +# Configure each individual brace in BraceWrapping +BreakBeforeBraces: Custom + +# Control of individual brace wrapping cases +BraceWrapping: { + AfterClass: 'true' + AfterControlStatement: 'false' + AfterEnum : 'true' + AfterFunction : 'false' + AfterNamespace : 'true' + AfterStruct : 'true' + AfterUnion : 'true' + BeforeCatch : 'true' + BeforeElse : 'true' + IndentBraces : 'false' +} +... diff --git a/CMakeLists.txt b/CMakeLists.txt index 8c63334..efb7a12 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,42 +1,32 @@ cmake_minimum_required(VERSION 2.8.3) project(wlan_pioneer) -add_compile_options(-std=c++11) - find_package(catkin REQUIRED COMPONENTS roscpp std_msgs message_generation ) -add_message_files( - FILES - WlanSignalMsg.msg -) +add_message_files(FILES WlanSignalMsg.msg) -generate_messages( - DEPENDENCIES - std_msgs -) +generate_messages(DEPENDENCIES std_msgs) -catkin_package( ) +catkin_package() -include_directories( - ${catkin_INCLUDE_DIRS} - /usr/local/include/ -) - -link_directories( - ${catkin_INCLUDE_DIRS} - /usr/local/lib/ -) +include_directories(${catkin_INCLUDE_DIRS} /usr/local/include/) +link_directories(${catkin_INCLUDE_DIRS} /usr/local/lib/) add_executable(wlanSignal src/wlanSignal.cpp) target_link_libraries(wlanSignal ${catkin_LIBRARIES} wifi-scan) add_dependencies(wlanSignal wlan_pioneer_generate_messages_cpp) -SET(CMAKE_INSTALL_RPATH ${catkin_LIBRARIES}) -SET(CMAKE_INSTALL_RPATH_USE_LINK_PATH TRUE) - +# This setting disable new dtags for ld linker. So RUNPATH is +# replaced with RPATH in wlanSignal executable. We need RPATH +# for finding linked libraries at runtime when executed with +# sudo. WLAN scanning needs enhanced privileges. With RUNPATH +# linker disables LD_LIBRARY_PATH for security reasons if +# setuid/setgid is set. So this is a workaround. +# https://gitlab.kitware.com/cmake/community/wikis/doc/cmake/RPATH-handling +# https://answers.ros.org/question/165246/launch-node-with-root-permissions/ SET(CMAKE_EXE_LINKER_FLAGS "-Wl,--disable-new-dtags") diff --git a/launch/wlanSignal.launch b/launch/wlanSignal.launch index 552e704..badd682 100644 --- a/launch/wlanSignal.launch +++ b/launch/wlanSignal.launch @@ -1,7 +1,7 @@ - - + + diff --git a/src/wlanSignal.cpp b/src/wlanSignal.cpp index 2a1cff8..6545a27 100644 --- a/src/wlanSignal.cpp +++ b/src/wlanSignal.cpp @@ -1,60 +1,60 @@ -#include "ros/ros.h" -#include "wlan_pioneer/WlanSignalMsg.h" -#include -#include -#include + #include #include +#include +#include "ros/ros.h" +#include "wlan_pioneer/WlanSignalMsg.h" #include "wifi_scan.h" using namespace std; using namespace ros; using namespace wlan_pioneer; -// Global variables for wifi scanning -const int MAX_APS = 64; // the maximum amounts of APs (Access Points) we want to store +const int MAX_APS = 64; // the maximum amounts of APs (Access Points) we want to store struct wifi_scan* wifi = nullptr; // this stores all the library information -struct bss_info bss[MAX_APS]; // this is where we are going to keep informatoin about APs (Access Points) +struct bss_info bss[MAX_APS]; // this is where we are going to keep informatoin about APs +WlanSignalMsg msg; // global message, will be set and published in every loop -WlanSignalMsg msg; void scanInterface( const string& interface, const string& monitoringSsid ) { - - msg.level_2G4 = numeric_limits::min(); - msg.level_5G = numeric_limits::min(); + msg.ssid = monitoringSsid; + msg.timestamp = Time::now(); + msg.level_2G4 = numeric_limits::min(); + msg.level_5G = numeric_limits::min(); msg.cellCount_2G4 = 0; - msg.cellCount_5G = 0; + msg.cellCount_5G = 0; if ( wifi == nullptr ) { + // initialise wlan for scanning wifi = wifi_scan_init( interface.c_str() ); } int status = wifi_scan_all( wifi, bss, MAX_APS ); - if ( status < 0 ) { ROS_ERROR( "Unable to get WLAN scan data: %s", std::strerror( errno ) ); - wifi_scan_close( wifi ); + wifi_scan_close( wifi ); // close wlan to re-init in next loop wifi = nullptr; return; } else { + // run trought list of cells for ( int i = 0; i < status && i < MAX_APS; ++i ) { if ( bss[i].seen_ms_ago > 100 ) { continue; // we do not want old results } if ( std::strcmp( bss[i].ssid, monitoringSsid.c_str() ) != 0 ) { - continue; + continue; // only cells on monitoring SSID should be scanned } - int8_t level = bss[i].signal_mbm / 100; + int8_t level = bss[i].signal_mbm / 100; // mBm to dBm if ( bss[i].frequency >= 2400 && bss[i].frequency <= 2499 ) { - // this AP is sending on 2.4 GHz band + // maximum of scanned levels of 2.4 GHz band msg.level_2G4 = std::max( msg.level_2G4, level ); msg.cellCount_2G4++; } else if ( bss[i].frequency >= 5000 && bss[i].frequency <= 5999 ) { - // this AP is sending on 5 GHz band + // maximum of scanned levels of 5 GHz band msg.level_5G = std::max( msg.level_5G, level ); msg.cellCount_5G++; } @@ -62,12 +62,15 @@ void scanInterface( const string& interface, const string& monitoringSsid ) { } } + int main( int argc, char** argv ) { init( argc, argv, "wlanSignal" ); NodeHandle node; string wlanInterface; string monitoringSsid; + Publisher publisher = node.advertise( "wlan_signal", 1000 ); + Rate loopRate = Rate( 1 ); // every second if ( node.param( "wlan_ssid", monitoringSsid, "" ) ) { ROS_INFO( "Param wlan_ssid: %s", monitoringSsid.c_str() ); @@ -83,23 +86,11 @@ int main( int argc, char** argv ) { ROS_INFO( "Param 'wlan_interface' not set. Using 'wlan0'" ); } - // topic: wlan_signal - Publisher publisher = node.advertise( "wlan_signal", 1000 ); - Rate loopRate( 1 ); // every second - - msg.ssid = monitoringSsid; - while ( ok() ) { - scanInterface( wlanInterface, monitoringSsid ); - msg.timestamp = Time::now(); - - ROS_INFO( "Signal strength 2.4G: %i (%d Cells) Signal strength 5G: %i (%d Cells)", - msg.level_2G4, - msg.cellCount_2G4, - msg.level_5G, - msg.cellCount_5G); - + ROS_INFO( "Signal strength 2.4G: %i (%d Cells) Signal strength 5G: %i " + "(%d Cells)", + msg.level_2G4, msg.cellCount_2G4, msg.level_5G, msg.cellCount_5G ); publisher.publish( msg ); spinOnce(); loopRate.sleep();