This somewhat trivial example show making use of the unified set of commands to print data from a MaxBotix ultrasonic range finder to the serial port. It also shows creating a calculated variable which is the water depth.
Unique Features of the Single Sensor Example Only communicates with and collects data from a single sensor. Does not make use of any VariableArray or logging features. To Use this Example Prepare and set up PlatformIO Create a new PlatformIO project Replace the contents of the platformio.ini for your new project with the platformio.ini file in the examples/single_sensor folder on GitHub.It is important that your PlatformIO configuration has the lib_ldf_mode and build flags set as they are in the example. Without this, the program won't compile. Open single_ and save it to your computer. Put it into the src directory of your project.Delete main.cpp in that folder. Upload! Upload and see what happens PlatformIO Configuration 1 ; PlatformIO Project Configuration File 3 ; Build options: build flags, source filter 4 ; Upload options: custom upload port, speed and extra flags 5 ; Library options: dependencies, extra library storages 6 ; Advanced options: extra scripting 8 ; Please visit documentation for the other options and examples 9 ; http://docs.platformio.org/page/projectconf.html 12 description = ModularSensors example requesting values from a single sensor 30 -DSDI12_EXTERNAL_PCINT 31 -DNEOSWSERIAL_EXTERNAL_PCINT 32 -DMQTT_MAX_PACKET_SIZE = 240 33 -DTINY_GSM_RX_BUFFER = 64 36 envirodiy/EnviroDIY_ModularSensors 37 ; ^^ Use this when working from an official release of the library 38 ; https://github.com/EnviroDIY/ModularSensors.git#develop 39 ; ^^ Use this when if you want to pull from the develop branch
The Complete Code 1 /** ========================================================================= 2 * @example{lineno} single_sensor.ino 3 * @copyright Stroud Water Research Center 4 * @license This example is published under the BSD-3 license. 5 * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org> 7 * @brief An example using only sensor functions and no logging. 9 * See [the walkthrough page](@ref example_single_sensor) for detailed 12 * @m_examplenavigation{example_single_sensor,} 13 * ======================================================================= */ 15 // ========================================================================== 16 // Include the base required libraries 17 // ========================================================================== 18 /** Start [includes] */ 19 // The Arduino library is needed for every Arduino program. 22 // Include the main header for ModularSensors 23 #include <ModularSensors.h> 26 // ========================================================================== 28 // ========================================================================== 29 /** Start [sketch_info] */ 30 // The name of this program file 31 const char * sketchName = "single_sensor.ino" ; 33 const int32_t serialBaud = 115200 ; // Baud rate for debugging 34 const int8_t greenLED = 8 ; // Pin for the green LED 35 const int8_t redLED = 9 ; // Pin for the red LED 36 /** End [sketch_info] */ 39 // ========================================================================== 40 // Set up the sensor object 41 // ========================================================================== 43 #include <sensors/MaxBotixSonar.h> 45 // Create a reference to the serial port for the sonar 46 HardwareSerial & sonarSerial = Serial1 ; // Use hardware serial if possible 48 const int8_t SonarPower = 22 ; // excite (power) pin 49 const int SonarTrigger = -1 ; // Trigger pin 51 // Create a new instance of the sonar sensor; 52 MaxBotixSonar sonar ( sonarSerial , SonarPower , SonarTrigger ); 54 // Create a new instance of the range variable; 55 MaxBotixSonar_Range sonar_range ( & sonar ); 58 /* Start [calculated variables] */ 59 // Create a function to calculate the water depth from the sonar range 60 // For this example, we'll assume that the sonar is mounted 5m above the stream 62 float calcDepth ( void ) { 63 float mountHeight = 5000 ; 64 float sonarRange = sonar_range . getValue (); 65 return mountHeight - sonarRange ; 67 // Create a calculated variable for the water depth 68 // Variable calcVar(functionName, VariableName, VariableUnit, Resolution, UUID, 69 // Code); VariableName must be a value from 70 // http://vocabulary.odm2.org/variablename/ VariableUnit must be a value from 71 // http://vocabulary.odm2.org/units/ 72 Variable waterDepth ( calcDepth , 0 , "waterDepth" , "millimeter" , "sonarDepth" , 73 "12345678-abcd-1234-ef00-1234567890ab" ); 74 /** End [calculated_variables] */ 77 // ========================================================================== 79 // ========================================================================== 80 /** Start [working_functions] */ 81 // Flashes to Mayfly's LED's 82 void greenRedFlash ( int numFlash = 4 ) { 83 for ( int i = 0 ; i < numFlash ; i ++ ) { 84 digitalWrite ( greenLED , HIGH ); 85 digitalWrite ( redLED , LOW ); 87 digitalWrite ( greenLED , LOW ); 88 digitalWrite ( redLED , HIGH ); 91 digitalWrite ( redLED , LOW ); 93 /** End [working_functions] */ 96 // ========================================================================== 97 // Arduino Setup Function 98 // ========================================================================== 101 // Start the primary serial connection 102 Serial . begin ( serialBaud ); 104 // Print a start-up note to the first serial port 105 Serial . print ( F ( "Now running " )); 106 Serial . println ( sketchName ); 108 Serial . print ( F ( "Using ModularSensors Library version " )); 109 Serial . println ( MODULAR_SENSORS_VERSION ); 111 // Start the stream for the sonar 112 sonarSerial . begin ( 9600 ); 114 // Set up pins for the LED's 115 pinMode ( greenLED , OUTPUT ); 116 pinMode ( redLED , OUTPUT ); 117 // Blink the LEDs to show the board is on and starting up 120 // Print a start-up note to the first serial port 121 Serial . println ( F ( "Single Sensor Example - Sonar Ranging" )); 129 // ========================================================================== 130 // Arduino Loop Function 131 // ========================================================================== 134 // Turn on the LED to show we're taking a reading 135 digitalWrite ( greenLED , HIGH ); 137 // Send power to the sensor 140 // Wake up the sensor 143 // Update the sensor value 146 // Print the sonar result 147 Serial . print ( "Current sonar range: " ); 148 Serial . println ( sonar_range . getValueString ()); 149 Serial . print ( "Calculated water depth: " ); 150 Serial . println ( waterDepth . getValueString ()); 152 // Put the sensor back to sleep 155 // Cut the sensor power 158 // Turn off the LED to show we're done with the reading 159 digitalWrite ( greenLED , LOW ); 161 // Wait for the next reading
