Skip to content

Commit 6df81e1

Browse files
authored
Update README.md
Use markdown h2 syntax for headers so they can be linked-to in guides
1 parent 6cea0d9 commit 6df81e1

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ The following drivers are based on the Adafruit Unified Sensor Driver:
5252

5353
Any driver that supports the Adafruit unified sensor abstraction layer will implement the Adafruit\_Sensor base class. There are two main typedefs and one enum defined in Adafruit_Sensor.h that are used to 'abstract' away the sensor details and values:
5454

55-
**Sensor Types (sensors\_type\_t)**
55+
## Sensor Types (`sensors_type_t`)
5656

5757
These pre-defined sensor types are used to properly handle the two related typedefs below, and allows us determine what types of units the sensor uses, etc.
5858

@@ -78,7 +78,7 @@ typedef enum
7878
} sensors_type_t;
7979
```
8080

81-
**Sensor Details (sensor\_t)**
81+
## Sensor Details (`sensor_t`)
8282

8383
This typedef describes the specific capabilities of this sensor, and allows us to know what sensor we are using beneath the abstraction layer.
8484

@@ -109,7 +109,7 @@ The individual fields are intended to be used as follows:
109109
- **resolution**: The smallest difference between two values that this sensor can report (in the appropriate SI unit)
110110
- **min\_delay**: The minimum delay in microseconds between two sensor events, or '0' if there is no constant sensor rate
111111

112-
**Sensor Data/Events (sensors\_event\_t)**
112+
## Sensor Data/Events (`sensors_event_t`)
113113

114114
This typedef is used to return sensor data from any sensor supported by the abstraction layer, using standard SI units and scales.
115115

@@ -149,7 +149,7 @@ It includes the following fields:
149149
- **timestamp**: time in milliseconds when the sensor value was read
150150
- **data[4]**: An array of four 32-bit values that allows us to encapsulate any type of sensor data via a simple union (further described below)
151151

152-
**Required Functions**
152+
## Required Functions
153153

154154
In addition to the two standard types and the sensor type enum, all drivers based on Adafruit_Sensor must also implement the following two functions:
155155

@@ -163,7 +163,7 @@ void getSensor(sensor_t*);
163163
```
164164
Calling this function will provide some basic information about the sensor (the sensor name, driver version, min and max values, etc.
165165

166-
**Standardised SI values for sensors\_event\_t**
166+
## Standardised SI values for `sensors_event_t`
167167

168168
A key part of the abstraction layer is the standardisation of values on SI units of a particular scale, which is accomplished via the data[4] union in sensors\_event\_t above. This 16 byte union includes fields for each main sensor type, and uses the following SI units and scales:
169169

0 commit comments

Comments
 (0)