Skip to content

Commit 4001f4b

Browse files
committed
syntax test
1 parent cdcd51f commit 4001f4b

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -63,30 +63,30 @@ if (mySoilSensor.begin() == false)
6363
}
6464
~~~
6565

66-
The begin method returns true if the sensor is connected and available, and false if it is not. If a value of ```false``` is returned in the above example, the sketch execution is halted.
66+
The begin method returns true if the sensor is connected and available, and false if it is not. If a value of *false* is returned in the above example, the sketch execution is halted.
6767

6868
### Usage
6969

7070
#### Read Value
71-
To read the value from the sensor, the ```readMoistureValue()``` method is called on the sensor object.
71+
To read the value from the sensor, the *readMoistureValue()* method is called on the sensor object.
7272

73-
```cpp
73+
~~~cpp
7474
uint16_t soilMoisture = mySoilSensor.readMoistureValue();
75-
```
75+
~~~
7676

7777
The value returned is from 0 (100% wet) to 1023 (0% web - "dry"). The value is a measurement of resistance between the sensors two probes. The value range is based on the capabilities of the Analog to Digital converter (ADC) on the sensors microcontroller - it's 10 bits with a max value of 2^10 = 1024.
7878

79-
To read the percent moist value, call the ```readMoisturePercentage()``` method:
79+
To read the percent moist value, call the *readMoisturePercentage()* method:
8080

81-
```cpp
81+
~~~cpp
8282
float percent = mySoilSensor.readMoisturePercentage();
83-
```
83+
~~~
8484

8585
To read the moisture ration value (0 - 1.0), call the ```readMoistureRation()``` method:
8686

87-
```cpp
87+
~~~cpp
8888
float wetRatio = mySoilSensor.readMoistureRatio();
89-
```
89+
~~~
9090

9191
#### Control the On-Sensor LED
9292

0 commit comments

Comments
 (0)