From f67b772704e4e8dc0b08dde1505ce567042288e2 Mon Sep 17 00:00:00 2001 From: Patrick <41267865+Patrick-McGuire@users.noreply.github.com> Date: Thu, 14 Nov 2024 20:56:20 -0500 Subject: [PATCH] update docs --- docs/html/ICM20948Sensor_8h_source.html | 4 ++-- docs/html/MS8607Sensor_8h_source.html | 4 ++-- docs/html/annotated.html | 18 +++++++------- docs/html/classBarometer__inherit__graph.dot | 2 +- .../classGenericSensor__inherit__graph.dot | 4 ++-- docs/html/classICM20948Sensor.html | 20 +++++++++++----- .../html/classICM20948Sensor__coll__graph.dot | 2 +- .../classICM20948Sensor__inherit__graph.dot | 2 +- docs/html/classMS8607Sensor.html | 10 +++++++- docs/html/classMS8607Sensor__coll__graph.dot | 2 +- .../classMS8607Sensor__inherit__graph.dot | 2 +- docs/html/classes.html | 4 ++-- docs/html/hierarchy.html | 10 ++++---- docs/html/inherit_graph_11.dot | 2 +- docs/html/inherit_graph_12.dot | 2 +- docs/html/inherit_graph_9.dot | 4 ++-- docs/html/inherits.html | 8 ++----- docs/html/search/all_7.js | 7 +++--- docs/html/search/all_9.js | 3 +-- docs/html/search/classes_6.js | 3 +-- docs/html/search/classes_8.js | 3 +-- docs/latex/ICM20948Sensor_8h_source.tex | 2 +- docs/latex/MS8607Sensor_8h_source.tex | 2 +- docs/latex/annotated.tex | 6 ++--- docs/latex/classBarometer__inherit__graph.dot | 2 +- .../classGenericSensor__inherit__graph.dot | 4 ++-- docs/latex/classICM20948Sensor.tex | 24 +++++++++++++++---- .../classICM20948Sensor__coll__graph.dot | 2 +- .../classICM20948Sensor__inherit__graph.dot | 2 +- docs/latex/classMS8607Sensor.tex | 14 +++++++++++ docs/latex/classMS8607Sensor__coll__graph.dot | 2 +- .../classMS8607Sensor__inherit__graph.dot | 2 +- docs/latex/hierarchy.tex | 2 -- docs/latex/refman.tex | 2 -- .../include/ICM20948Sensor.h | 2 +- .../include/MS8607Sensor.h | 2 +- 36 files changed, 106 insertions(+), 80 deletions(-) diff --git a/docs/html/ICM20948Sensor_8h_source.html b/docs/html/ICM20948Sensor_8h_source.html index 72c9a8f..4372dd5 100644 --- a/docs/html/ICM20948Sensor_8h_source.html +++ b/docs/html/ICM20948Sensor_8h_source.html @@ -87,7 +87,7 @@
9#include <ICM_20948.h>
10
11/**
-
12 * @class ICM20948
+
12 * @class ICM20948Sensor
13 * @brief Driver for ICM20948
14 * @details Uses the sparkfun Arduino ICM20948 library, and abstracts it to our sensor formats
15 */
@@ -158,7 +158,7 @@
Accelerometer
Generic Accelerometer.
Definition: Accelerometer.h:12
GenericSensor
Underlying interface to all sensors.
Definition: GenericSensor.h:12
Gyroscope
Generic Gyroscope.
Definition: Gyroscope.h:12
-
ICM20948Sensor
Definition: ICM20948Sensor.h:16
+
ICM20948Sensor
Driver for ICM20948.
Definition: ICM20948Sensor.h:16
ICM20948Sensor::getGyroscope
Gyroscope * getGyroscope()
Gets the Gyroscope injector class.
Definition: ICM20948Sensor.cpp:86
ICM20948Sensor::setup
void setup() final
Initializes the sensor.
Definition: ICM20948Sensor.cpp:9
ICM20948Sensor::setSpiClass
void setSpiClass(SPIClass *spiClass)
Sets the SPI object to use.
Definition: ICM20948Sensor.cpp:5
diff --git a/docs/html/MS8607Sensor_8h_source.html b/docs/html/MS8607Sensor_8h_source.html index 9d674a3..337271b 100644 --- a/docs/html/MS8607Sensor_8h_source.html +++ b/docs/html/MS8607Sensor_8h_source.html @@ -85,7 +85,7 @@
7#include <SparkFun_PHT_MS8607_Arduino_Library.h> // library for MS8607
8
9/**
-
10 * @class MS8607driver
+
10 * @class MS8607Sensor
11 * @brief An implementation of Barometer for the MS8607 barometer.
12 * @details Uses the SparkFun PHT MS8607 Arduino library and implements an abstraction layer for our format.
13 * The datasheet can be found here: https://cdn.sparkfun.com/assets/b/a/f/b/f/MS8607_Datasheet.pdf
@@ -112,7 +112,7 @@
34
35#endif //PLATFORMIO_NULI_AVIONICS_FLIGHT_SOFTWARE_MS8607SENSOR_H
Barometer
Generic Barometer.
Definition: Barometer.h:12
-
MS8607Sensor
Definition: MS8607Sensor.h:16
+
MS8607Sensor
An implementation of Barometer for the MS8607 barometer.
Definition: MS8607Sensor.h:16
MS8607Sensor::read
void read() override
Read data from the sensor.
Definition: MS8607Sensor.cpp:21
MS8607Sensor::setup
void setup() override
Initialize the sensor.
Definition: MS8607Sensor.cpp:7
diff --git a/docs/html/annotated.html b/docs/html/annotated.html index 218e583..c7ba680 100644 --- a/docs/html/annotated.html +++ b/docs/html/annotated.html @@ -89,16 +89,14 @@  CGPS  CGyroscopeGeneric Gyroscope  CHardwareAbstractionProvide an abstraction to access all hardware - CICM20948Driver for ICM20948 - CICM20948Sensor - CLogger - CMagnetometerGeneric Magnetometer - CMS8607driverAn implementation of Barometer for the MS8607 barometer - CMS8607Sensor - CPyroRepresents a pyro channel - CRadioTransmitterLink - CSerialConnectionLink - CVector3D_sVector with 3 axis + CICM20948SensorDriver for ICM20948 + CLogger + CMagnetometerGeneric Magnetometer + CMS8607SensorAn implementation of Barometer for the MS8607 barometer + CPyroRepresents a pyro channel + CRadioTransmitterLink + CSerialConnectionLink + CVector3D_sVector with 3 axis diff --git a/docs/html/classBarometer__inherit__graph.dot b/docs/html/classBarometer__inherit__graph.dot index 24f28ba..a659950 100644 --- a/docs/html/classBarometer__inherit__graph.dot +++ b/docs/html/classBarometer__inherit__graph.dot @@ -8,5 +8,5 @@ digraph "Barometer" Node2 -> Node1 [dir="back",color="steelblue1",style="solid"]; Node2 [label="GenericSensor",height=0.2,width=0.4,color="gray40", fillcolor="white", style="filled",URL="$classGenericSensor.html",tooltip="Underlying interface to all sensors."]; Node1 -> Node3 [dir="back",color="steelblue1",style="solid"]; - Node3 [label="MS8607Sensor",height=0.2,width=0.4,color="grey75", fillcolor="white", style="filled",URL="$classMS8607Sensor.html",tooltip=" "]; + Node3 [label="MS8607Sensor",height=0.2,width=0.4,color="gray40", fillcolor="white", style="filled",URL="$classMS8607Sensor.html",tooltip="An implementation of Barometer for the MS8607 barometer."]; } diff --git a/docs/html/classGenericSensor__inherit__graph.dot b/docs/html/classGenericSensor__inherit__graph.dot index 22b8f99..e81fc45 100644 --- a/docs/html/classGenericSensor__inherit__graph.dot +++ b/docs/html/classGenericSensor__inherit__graph.dot @@ -10,13 +10,13 @@ digraph "GenericSensor" Node1 -> Node3 [dir="back",color="steelblue1",style="solid"]; Node3 [label="Barometer",height=0.2,width=0.4,color="gray40", fillcolor="white", style="filled",URL="$classBarometer.html",tooltip="Generic Barometer."]; Node3 -> Node4 [dir="back",color="steelblue1",style="solid"]; - Node4 [label="MS8607Sensor",height=0.2,width=0.4,color="grey75", fillcolor="white", style="filled",URL="$classMS8607Sensor.html",tooltip=" "]; + Node4 [label="MS8607Sensor",height=0.2,width=0.4,color="gray40", fillcolor="white", style="filled",URL="$classMS8607Sensor.html",tooltip="An implementation of Barometer for the MS8607 barometer."]; Node1 -> Node5 [dir="back",color="steelblue1",style="solid"]; Node5 [label="GPS",height=0.2,width=0.4,color="grey75", fillcolor="white", style="filled",URL="$classGPS.html",tooltip=" "]; Node1 -> Node6 [dir="back",color="steelblue1",style="solid"]; Node6 [label="Gyroscope",height=0.2,width=0.4,color="gray40", fillcolor="white", style="filled",URL="$classGyroscope.html",tooltip="Generic Gyroscope."]; Node1 -> Node7 [dir="back",color="steelblue1",style="solid"]; - Node7 [label="ICM20948Sensor",height=0.2,width=0.4,color="grey75", fillcolor="white", style="filled",URL="$classICM20948Sensor.html",tooltip=" "]; + Node7 [label="ICM20948Sensor",height=0.2,width=0.4,color="gray40", fillcolor="white", style="filled",URL="$classICM20948Sensor.html",tooltip="Driver for ICM20948."]; Node1 -> Node8 [dir="back",color="steelblue1",style="solid"]; Node8 [label="Magnetometer",height=0.2,width=0.4,color="gray40", fillcolor="white", style="filled",URL="$classMagnetometer.html",tooltip="Generic Magnetometer."]; Node1 -> Node9 [dir="back",color="steelblue1",style="solid"]; diff --git a/docs/html/classICM20948Sensor.html b/docs/html/classICM20948Sensor.html index f0e8929..e617099 100644 --- a/docs/html/classICM20948Sensor.html +++ b/docs/html/classICM20948Sensor.html @@ -75,6 +75,11 @@
ICM20948Sensor Class Referencefinal
+ +

Driver for ICM20948. + More...

+ +

#include <ICM20948Sensor.h>

Inheritance diagram for ICM20948Sensor:
@@ -89,7 +94,7 @@

Public Member Functions

 ICM20948Sensor (uint8_t chipSelectPin) - Creates a ICM20948.
+ Creates a ICM20948.
  void setSpiClass (SPIClass *spiClass)  Sets the SPI object to use.
@@ -116,7 +121,10 @@  Read data from the sensor.
  -

Constructor & Destructor Documentation

+

Detailed Description

+

Driver for ICM20948.

+

Uses the sparkfun Arduino ICM20948 library, and abstracts it to our sensor formats

+

Constructor & Destructor Documentation

◆ ICM20948Sensor()

@@ -141,7 +149,7 @@

-

Creates a ICM20948.

+

Creates a ICM20948.

Parameters
@@ -168,7 +176,7 @@

Gets the Accelerometer injector class.

-

Injector classes are used to pass data to the HardwareAbstraction. The ICM20948 is basically a 3 in one sensor, so we make a "dummy" class for each of the 3 sensors, and pass data through it.

Returns
Accelerometer injector class
+

Injector classes are used to pass data to the HardwareAbstraction. The ICM20948 is basically a 3 in one sensor, so we make a "dummy" class for each of the 3 sensors, and pass data through it.

Returns
Accelerometer injector class
@@ -188,7 +196,7 @@

Gets the Gyroscope injector class.

-

Injector classes are used to pass data to the HardwareAbstraction. The ICM20948 is basically a 3 in one sensor, so we make a "dummy" class for each of the 3 sensors, and pass data through it.

Returns
Gyroscope injector class
+

Injector classes are used to pass data to the HardwareAbstraction. The ICM20948 is basically a 3 in one sensor, so we make a "dummy" class for each of the 3 sensors, and pass data through it.

Returns
Gyroscope injector class
@@ -208,7 +216,7 @@

Gets the Magnetometer injector class.

-

Injector classes are used to pass data to the HardwareAbstraction. The ICM20948 is basically a 3 in one sensor, so we make a "dummy" class for each of the 3 sensors, and pass data through it.

Returns
Magnetometer injector class
+

Injector classes are used to pass data to the HardwareAbstraction. The ICM20948 is basically a 3 in one sensor, so we make a "dummy" class for each of the 3 sensors, and pass data through it.

Returns
Magnetometer injector class
diff --git a/docs/html/classICM20948Sensor__coll__graph.dot b/docs/html/classICM20948Sensor__coll__graph.dot index 9cacd15..ebb7ebc 100644 --- a/docs/html/classICM20948Sensor__coll__graph.dot +++ b/docs/html/classICM20948Sensor__coll__graph.dot @@ -4,7 +4,7 @@ digraph "ICM20948Sensor" bgcolor="transparent"; edge [fontname=Helvetica,fontsize=10,labelfontname=Helvetica,labelfontsize=10]; node [fontname=Helvetica,fontsize=10,shape=box,height=0.2,width=0.4]; - Node1 [label="ICM20948Sensor",height=0.2,width=0.4,color="gray40", fillcolor="grey60", style="filled", fontcolor="black",tooltip=" "]; + Node1 [label="ICM20948Sensor",height=0.2,width=0.4,color="gray40", fillcolor="grey60", style="filled", fontcolor="black",tooltip="Driver for ICM20948."]; Node2 -> Node1 [dir="back",color="steelblue1",style="solid"]; Node2 [label="GenericSensor",height=0.2,width=0.4,color="gray40", fillcolor="white", style="filled",URL="$classGenericSensor.html",tooltip="Underlying interface to all sensors."]; } diff --git a/docs/html/classICM20948Sensor__inherit__graph.dot b/docs/html/classICM20948Sensor__inherit__graph.dot index 9cacd15..ebb7ebc 100644 --- a/docs/html/classICM20948Sensor__inherit__graph.dot +++ b/docs/html/classICM20948Sensor__inherit__graph.dot @@ -4,7 +4,7 @@ digraph "ICM20948Sensor" bgcolor="transparent"; edge [fontname=Helvetica,fontsize=10,labelfontname=Helvetica,labelfontsize=10]; node [fontname=Helvetica,fontsize=10,shape=box,height=0.2,width=0.4]; - Node1 [label="ICM20948Sensor",height=0.2,width=0.4,color="gray40", fillcolor="grey60", style="filled", fontcolor="black",tooltip=" "]; + Node1 [label="ICM20948Sensor",height=0.2,width=0.4,color="gray40", fillcolor="grey60", style="filled", fontcolor="black",tooltip="Driver for ICM20948."]; Node2 -> Node1 [dir="back",color="steelblue1",style="solid"]; Node2 [label="GenericSensor",height=0.2,width=0.4,color="gray40", fillcolor="white", style="filled",URL="$classGenericSensor.html",tooltip="Underlying interface to all sensors."]; } diff --git a/docs/html/classMS8607Sensor.html b/docs/html/classMS8607Sensor.html index 67bed4b..8cf876b 100644 --- a/docs/html/classMS8607Sensor.html +++ b/docs/html/classMS8607Sensor.html @@ -75,6 +75,11 @@
MS8607Sensor Class Reference
+ +

An implementation of Barometer for the MS8607 barometer. + More...

+ +

#include <MS8607Sensor.h>

Inheritance diagram for MS8607Sensor:
@@ -150,7 +155,10 @@

chipSelectPinChip select pin for the SPI bus
 The calculated altitude.
 
-

Member Function Documentation

+

Detailed Description

+

An implementation of Barometer for the MS8607 barometer.

+

Uses the SparkFun PHT MS8607 Arduino library and implements an abstraction layer for our format. The datasheet can be found here: https://cdn.sparkfun.com/assets/b/a/f/b/f/MS8607_Datasheet.pdf

+

Member Function Documentation

◆ read()

diff --git a/docs/html/classMS8607Sensor__coll__graph.dot b/docs/html/classMS8607Sensor__coll__graph.dot index 7a4328c..5528777 100644 --- a/docs/html/classMS8607Sensor__coll__graph.dot +++ b/docs/html/classMS8607Sensor__coll__graph.dot @@ -4,7 +4,7 @@ digraph "MS8607Sensor" bgcolor="transparent"; edge [fontname=Helvetica,fontsize=10,labelfontname=Helvetica,labelfontsize=10]; node [fontname=Helvetica,fontsize=10,shape=box,height=0.2,width=0.4]; - Node1 [label="MS8607Sensor",height=0.2,width=0.4,color="gray40", fillcolor="grey60", style="filled", fontcolor="black",tooltip=" "]; + Node1 [label="MS8607Sensor",height=0.2,width=0.4,color="gray40", fillcolor="grey60", style="filled", fontcolor="black",tooltip="An implementation of Barometer for the MS8607 barometer."]; Node2 -> Node1 [dir="back",color="steelblue1",style="solid"]; Node2 [label="Barometer",height=0.2,width=0.4,color="gray40", fillcolor="white", style="filled",URL="$classBarometer.html",tooltip="Generic Barometer."]; Node3 -> Node2 [dir="back",color="steelblue1",style="solid"]; diff --git a/docs/html/classMS8607Sensor__inherit__graph.dot b/docs/html/classMS8607Sensor__inherit__graph.dot index 7a4328c..5528777 100644 --- a/docs/html/classMS8607Sensor__inherit__graph.dot +++ b/docs/html/classMS8607Sensor__inherit__graph.dot @@ -4,7 +4,7 @@ digraph "MS8607Sensor" bgcolor="transparent"; edge [fontname=Helvetica,fontsize=10,labelfontname=Helvetica,labelfontsize=10]; node [fontname=Helvetica,fontsize=10,shape=box,height=0.2,width=0.4]; - Node1 [label="MS8607Sensor",height=0.2,width=0.4,color="gray40", fillcolor="grey60", style="filled", fontcolor="black",tooltip=" "]; + Node1 [label="MS8607Sensor",height=0.2,width=0.4,color="gray40", fillcolor="grey60", style="filled", fontcolor="black",tooltip="An implementation of Barometer for the MS8607 barometer."]; Node2 -> Node1 [dir="back",color="steelblue1",style="solid"]; Node2 [label="Barometer",height=0.2,width=0.4,color="gray40", fillcolor="white", style="filled",URL="$classBarometer.html",tooltip="Generic Barometer."]; Node3 -> Node2 [dir="back",color="steelblue1",style="solid"]; diff --git a/docs/html/classes.html b/docs/html/classes.html index c6dd618..748965f 100644 --- a/docs/html/classes.html +++ b/docs/html/classes.html @@ -94,13 +94,13 @@
HardwareAbstraction
I
-
ICM20948
ICM20948Sensor
+
ICM20948Sensor
L
Logger
M
-
Magnetometer
MS8607driver
MS8607Sensor
+
Magnetometer
MS8607Sensor
P
Pyro
diff --git a/docs/html/hierarchy.html b/docs/html/hierarchy.html index 60a15cb..80af0a5 100644 --- a/docs/html/hierarchy.html +++ b/docs/html/hierarchy.html @@ -90,17 +90,15 @@  ▼CGenericSensorUnderlying interface to all sensors  CAccelerometerGeneric Accelerometer  ▼CBarometerGeneric Barometer - CMS8607Sensor + CMS8607SensorAn implementation of Barometer for the MS8607 barometer  CGPS  CGyroscopeGeneric Gyroscope - CICM20948Sensor + CICM20948SensorDriver for ICM20948  CMagnetometerGeneric Magnetometer  CPyroRepresents a pyro channel  CHardwareAbstractionProvide an abstraction to access all hardware - CICM20948Driver for ICM20948 - CLogger - CMS8607driverAn implementation of Barometer for the MS8607 barometer - CVector3D_sVector with 3 axis + CLogger + CVector3D_sVector with 3 axis

diff --git a/docs/html/inherit_graph_11.dot b/docs/html/inherit_graph_11.dot index 91be6a9..b28f3f7 100644 --- a/docs/html/inherit_graph_11.dot +++ b/docs/html/inherit_graph_11.dot @@ -5,5 +5,5 @@ digraph "Graphical Class Hierarchy" edge [fontname=Helvetica,fontsize=10,labelfontname=Helvetica,labelfontsize=10]; node [fontname=Helvetica,fontsize=10,shape=box,height=0.2,width=0.4]; rankdir="LR"; - Node0 [label="ICM20948",height=0.2,width=0.4,color="grey40", fillcolor="white", style="filled",URL="$classICM20948.html",tooltip="Driver for ICM20948."]; + Node0 [label="Logger",height=0.2,width=0.4,color="grey40", fillcolor="white", style="filled",URL="$classLogger.html",tooltip=" "]; } diff --git a/docs/html/inherit_graph_12.dot b/docs/html/inherit_graph_12.dot index b28f3f7..abbce08 100644 --- a/docs/html/inherit_graph_12.dot +++ b/docs/html/inherit_graph_12.dot @@ -5,5 +5,5 @@ digraph "Graphical Class Hierarchy" edge [fontname=Helvetica,fontsize=10,labelfontname=Helvetica,labelfontsize=10]; node [fontname=Helvetica,fontsize=10,shape=box,height=0.2,width=0.4]; rankdir="LR"; - Node0 [label="Logger",height=0.2,width=0.4,color="grey40", fillcolor="white", style="filled",URL="$classLogger.html",tooltip=" "]; + Node0 [label="Vector3D_s",height=0.2,width=0.4,color="grey40", fillcolor="white", style="filled",URL="$structVector3D__s.html",tooltip="Vector with 3 axis."]; } diff --git a/docs/html/inherit_graph_9.dot b/docs/html/inherit_graph_9.dot index 944f118..724c655 100644 --- a/docs/html/inherit_graph_9.dot +++ b/docs/html/inherit_graph_9.dot @@ -11,13 +11,13 @@ digraph "Graphical Class Hierarchy" Node0 -> Node2 [dir="back",color="steelblue1",style="solid"]; Node2 [label="Barometer",height=0.2,width=0.4,color="grey40", fillcolor="white", style="filled",URL="$classBarometer.html",tooltip="Generic Barometer."]; Node2 -> Node3 [dir="back",color="steelblue1",style="solid"]; - Node3 [label="MS8607Sensor",height=0.2,width=0.4,color="grey40", fillcolor="white", style="filled",URL="$classMS8607Sensor.html",tooltip=" "]; + Node3 [label="MS8607Sensor",height=0.2,width=0.4,color="grey40", fillcolor="white", style="filled",URL="$classMS8607Sensor.html",tooltip="An implementation of Barometer for the MS8607 barometer."]; Node0 -> Node4 [dir="back",color="steelblue1",style="solid"]; Node4 [label="GPS",height=0.2,width=0.4,color="grey40", fillcolor="white", style="filled",URL="$classGPS.html",tooltip=" "]; Node0 -> Node5 [dir="back",color="steelblue1",style="solid"]; Node5 [label="Gyroscope",height=0.2,width=0.4,color="grey40", fillcolor="white", style="filled",URL="$classGyroscope.html",tooltip="Generic Gyroscope."]; Node0 -> Node6 [dir="back",color="steelblue1",style="solid"]; - Node6 [label="ICM20948Sensor",height=0.2,width=0.4,color="grey40", fillcolor="white", style="filled",URL="$classICM20948Sensor.html",tooltip=" "]; + Node6 [label="ICM20948Sensor",height=0.2,width=0.4,color="grey40", fillcolor="white", style="filled",URL="$classICM20948Sensor.html",tooltip="Driver for ICM20948."]; Node0 -> Node7 [dir="back",color="steelblue1",style="solid"]; Node7 [label="Magnetometer",height=0.2,width=0.4,color="grey40", fillcolor="white", style="filled",URL="$classMagnetometer.html",tooltip="Generic Magnetometer."]; Node0 -> Node8 [dir="back",color="steelblue1",style="solid"]; diff --git a/docs/html/inherits.html b/docs/html/inherits.html index 79c5a50..1777f11 100644 --- a/docs/html/inherits.html +++ b/docs/html/inherits.html @@ -97,13 +97,9 @@ - + - - - - - + diff --git a/docs/html/search/all_7.js b/docs/html/search/all_7.js index 9097d14..0b78de9 100644 --- a/docs/html/search/all_7.js +++ b/docs/html/search/all_7.js @@ -1,7 +1,6 @@ var searchData= [ - ['icm20948_0',['ICM20948',['../classICM20948.html',1,'']]], - ['icm20948sensor_1',['ICM20948Sensor',['../classICM20948Sensor.html',1,'ICM20948Sensor'],['../classICM20948Sensor.html#ad83c1c6ba1547c9e8f4d597f89782342',1,'ICM20948Sensor::ICM20948Sensor()']]], - ['inject_2',['inject',['../classAccelerometer.html#aede2678f49c7c07a7b237c3c02c7d3a8',1,'Accelerometer::inject()'],['../classBarometer.html#ae99e33ec786c4764feb3e88c46c29706',1,'Barometer::inject()'],['../classGyroscope.html#a51a863495e112214429ca5b239efc63b',1,'Gyroscope::inject()'],['../classMagnetometer.html#a7844b1a4c64534c1b0495966cd6a9417',1,'Magnetometer::inject()']]], - ['iscurrentlytransmitting_3',['isCurrentlyTransmitting',['../classAprsTransmitter.html#a76a01cb277f95d778928a0b422c395e6',1,'AprsTransmitter']]] + ['icm20948sensor_0',['ICM20948Sensor',['../classICM20948Sensor.html',1,'ICM20948Sensor'],['../classICM20948Sensor.html#ad83c1c6ba1547c9e8f4d597f89782342',1,'ICM20948Sensor::ICM20948Sensor()']]], + ['inject_1',['inject',['../classAccelerometer.html#aede2678f49c7c07a7b237c3c02c7d3a8',1,'Accelerometer::inject()'],['../classBarometer.html#ae99e33ec786c4764feb3e88c46c29706',1,'Barometer::inject()'],['../classGyroscope.html#a51a863495e112214429ca5b239efc63b',1,'Gyroscope::inject()'],['../classMagnetometer.html#a7844b1a4c64534c1b0495966cd6a9417',1,'Magnetometer::inject()']]], + ['iscurrentlytransmitting_2',['isCurrentlyTransmitting',['../classAprsTransmitter.html#a76a01cb277f95d778928a0b422c395e6',1,'AprsTransmitter']]] ]; diff --git a/docs/html/search/all_9.js b/docs/html/search/all_9.js index efafc8e..20c3249 100644 --- a/docs/html/search/all_9.js +++ b/docs/html/search/all_9.js @@ -15,6 +15,5 @@ var searchData= ['m_5fvelocitiesrads_12',['m_velocitiesRadS',['../classGyroscope.html#afe6003bb25f78698360f876b47579780',1,'Gyroscope']]], ['magnetometer_13',['Magnetometer',['../classMagnetometer.html',1,'']]], ['maximum_5fbits_14',['MAXIMUM_BITS',['../classAprsTransmitter.html#a4011c0bca8ef9398ad2d11e0a07fd9ca',1,'AprsTransmitter']]], - ['ms8607driver_15',['MS8607driver',['../classMS8607driver.html',1,'']]], - ['ms8607sensor_16',['MS8607Sensor',['../classMS8607Sensor.html',1,'']]] + ['ms8607sensor_15',['MS8607Sensor',['../classMS8607Sensor.html',1,'']]] ]; diff --git a/docs/html/search/classes_6.js b/docs/html/search/classes_6.js index 809efab..c81bc2e 100644 --- a/docs/html/search/classes_6.js +++ b/docs/html/search/classes_6.js @@ -1,5 +1,4 @@ var searchData= [ - ['icm20948_0',['ICM20948',['../classICM20948.html',1,'']]], - ['icm20948sensor_1',['ICM20948Sensor',['../classICM20948Sensor.html',1,'']]] + ['icm20948sensor_0',['ICM20948Sensor',['../classICM20948Sensor.html',1,'']]] ]; diff --git a/docs/html/search/classes_8.js b/docs/html/search/classes_8.js index f23b17e..edb01c1 100644 --- a/docs/html/search/classes_8.js +++ b/docs/html/search/classes_8.js @@ -1,6 +1,5 @@ var searchData= [ ['magnetometer_0',['Magnetometer',['../classMagnetometer.html',1,'']]], - ['ms8607driver_1',['MS8607driver',['../classMS8607driver.html',1,'']]], - ['ms8607sensor_2',['MS8607Sensor',['../classMS8607Sensor.html',1,'']]] + ['ms8607sensor_1',['MS8607Sensor',['../classMS8607Sensor.html',1,'']]] ]; diff --git a/docs/latex/ICM20948Sensor_8h_source.tex b/docs/latex/ICM20948Sensor_8h_source.tex index fe06537..3e0b1f7 100644 --- a/docs/latex/ICM20948Sensor_8h_source.tex +++ b/docs/latex/ICM20948Sensor_8h_source.tex @@ -13,7 +13,7 @@ \DoxyCodeLine{00009\ \textcolor{preprocessor}{\#include\ }} \DoxyCodeLine{00010\ \textcolor{comment}{}} \DoxyCodeLine{00011\ \textcolor{comment}{/**}} -\DoxyCodeLine{00012\ \textcolor{comment}{\ *\ @class\ ICM20948}} +\DoxyCodeLine{00012\ \textcolor{comment}{\ *\ @class\ ICM20948Sensor}} \DoxyCodeLine{00013\ \textcolor{comment}{\ *\ @brief\ Driver\ for\ ICM20948}} \DoxyCodeLine{00014\ \textcolor{comment}{\ *\ @details\ Uses\ the\ sparkfun\ Arduino\ ICM20948\ library,\ and\ abstracts\ it\ to\ our\ sensor\ formats}} \DoxyCodeLine{00015\ \textcolor{comment}{\ */}} diff --git a/docs/latex/MS8607Sensor_8h_source.tex b/docs/latex/MS8607Sensor_8h_source.tex index 0169970..d5eda52 100644 --- a/docs/latex/MS8607Sensor_8h_source.tex +++ b/docs/latex/MS8607Sensor_8h_source.tex @@ -11,7 +11,7 @@ \DoxyCodeLine{00007\ \textcolor{preprocessor}{\#include\ }\ \ \ \ \textcolor{comment}{//\ library\ for\ MS8607}} \DoxyCodeLine{00008\ \textcolor{comment}{}} \DoxyCodeLine{00009\ \textcolor{comment}{/**}} -\DoxyCodeLine{00010\ \textcolor{comment}{\ *\ @class\ MS8607driver}} +\DoxyCodeLine{00010\ \textcolor{comment}{\ *\ @class\ MS8607Sensor}} \DoxyCodeLine{00011\ \textcolor{comment}{\ *\ @brief\ An\ implementation\ of\ Barometer\ for\ the\ MS8607\ barometer.}} \DoxyCodeLine{00012\ \textcolor{comment}{\ *\ @details\ Uses\ the\ SparkFun\ PHT\ MS8607\ Arduino\ library\ and\ implements\ an\ abstraction\ layer\ for\ our\ format.}} \DoxyCodeLine{00013\ \textcolor{comment}{\ *\ The\ datasheet\ can\ be\ found\ here:\ https://cdn.sparkfun.com/assets/b/a/f/b/f/MS8607\_Datasheet.pdf}} diff --git a/docs/latex/annotated.tex b/docs/latex/annotated.tex index 9466969..2a1996e 100644 --- a/docs/latex/annotated.tex +++ b/docs/latex/annotated.tex @@ -15,12 +15,10 @@ \item\contentsline{section}{\mbox{\hyperlink{classGPS}{GPS}} }{\pageref{classGPS}}{} \item\contentsline{section}{\mbox{\hyperlink{classGyroscope}{Gyroscope}} \\*Generic \mbox{\hyperlink{classGyroscope}{Gyroscope}} }{\pageref{classGyroscope}}{} \item\contentsline{section}{\mbox{\hyperlink{classHardwareAbstraction}{Hardware\+Abstraction}} \\*Provide an abstraction to access all hardware }{\pageref{classHardwareAbstraction}}{} -\item\contentsline{section}{\mbox{\hyperlink{classICM20948}{ICM20948}} \\*Driver for \mbox{\hyperlink{classICM20948}{ICM20948}} }{\pageref{classICM20948}}{} -\item\contentsline{section}{\mbox{\hyperlink{classICM20948Sensor}{ICM20948\+Sensor}} }{\pageref{classICM20948Sensor}}{} +\item\contentsline{section}{\mbox{\hyperlink{classICM20948Sensor}{ICM20948\+Sensor}} \\*Driver for ICM20948 }{\pageref{classICM20948Sensor}}{} \item\contentsline{section}{\mbox{\hyperlink{classLogger}{Logger}} }{\pageref{classLogger}}{} \item\contentsline{section}{\mbox{\hyperlink{classMagnetometer}{Magnetometer}} \\*Generic \mbox{\hyperlink{classMagnetometer}{Magnetometer}} }{\pageref{classMagnetometer}}{} -\item\contentsline{section}{\mbox{\hyperlink{classMS8607driver}{MS8607driver}} \\*An implementation of \mbox{\hyperlink{classBarometer}{Barometer}} for the MS8607 barometer }{\pageref{classMS8607driver}}{} -\item\contentsline{section}{\mbox{\hyperlink{classMS8607Sensor}{MS8607\+Sensor}} }{\pageref{classMS8607Sensor}}{} +\item\contentsline{section}{\mbox{\hyperlink{classMS8607Sensor}{MS8607\+Sensor}} \\*An implementation of \mbox{\hyperlink{classBarometer}{Barometer}} for the MS8607 barometer }{\pageref{classMS8607Sensor}}{} \item\contentsline{section}{\mbox{\hyperlink{classPyro}{Pyro}} \\*Represents a pyro channel }{\pageref{classPyro}}{} \item\contentsline{section}{\mbox{\hyperlink{classRadioTransmitterLink}{Radio\+Transmitter\+Link}} }{\pageref{classRadioTransmitterLink}}{} \item\contentsline{section}{\mbox{\hyperlink{classSerialConnectionLink}{Serial\+Connection\+Link}} }{\pageref{classSerialConnectionLink}}{} diff --git a/docs/latex/classBarometer__inherit__graph.dot b/docs/latex/classBarometer__inherit__graph.dot index 24f28ba..a659950 100644 --- a/docs/latex/classBarometer__inherit__graph.dot +++ b/docs/latex/classBarometer__inherit__graph.dot @@ -8,5 +8,5 @@ digraph "Barometer" Node2 -> Node1 [dir="back",color="steelblue1",style="solid"]; Node2 [label="GenericSensor",height=0.2,width=0.4,color="gray40", fillcolor="white", style="filled",URL="$classGenericSensor.html",tooltip="Underlying interface to all sensors."]; Node1 -> Node3 [dir="back",color="steelblue1",style="solid"]; - Node3 [label="MS8607Sensor",height=0.2,width=0.4,color="grey75", fillcolor="white", style="filled",URL="$classMS8607Sensor.html",tooltip=" "]; + Node3 [label="MS8607Sensor",height=0.2,width=0.4,color="gray40", fillcolor="white", style="filled",URL="$classMS8607Sensor.html",tooltip="An implementation of Barometer for the MS8607 barometer."]; } diff --git a/docs/latex/classGenericSensor__inherit__graph.dot b/docs/latex/classGenericSensor__inherit__graph.dot index 22b8f99..e81fc45 100644 --- a/docs/latex/classGenericSensor__inherit__graph.dot +++ b/docs/latex/classGenericSensor__inherit__graph.dot @@ -10,13 +10,13 @@ digraph "GenericSensor" Node1 -> Node3 [dir="back",color="steelblue1",style="solid"]; Node3 [label="Barometer",height=0.2,width=0.4,color="gray40", fillcolor="white", style="filled",URL="$classBarometer.html",tooltip="Generic Barometer."]; Node3 -> Node4 [dir="back",color="steelblue1",style="solid"]; - Node4 [label="MS8607Sensor",height=0.2,width=0.4,color="grey75", fillcolor="white", style="filled",URL="$classMS8607Sensor.html",tooltip=" "]; + Node4 [label="MS8607Sensor",height=0.2,width=0.4,color="gray40", fillcolor="white", style="filled",URL="$classMS8607Sensor.html",tooltip="An implementation of Barometer for the MS8607 barometer."]; Node1 -> Node5 [dir="back",color="steelblue1",style="solid"]; Node5 [label="GPS",height=0.2,width=0.4,color="grey75", fillcolor="white", style="filled",URL="$classGPS.html",tooltip=" "]; Node1 -> Node6 [dir="back",color="steelblue1",style="solid"]; Node6 [label="Gyroscope",height=0.2,width=0.4,color="gray40", fillcolor="white", style="filled",URL="$classGyroscope.html",tooltip="Generic Gyroscope."]; Node1 -> Node7 [dir="back",color="steelblue1",style="solid"]; - Node7 [label="ICM20948Sensor",height=0.2,width=0.4,color="grey75", fillcolor="white", style="filled",URL="$classICM20948Sensor.html",tooltip=" "]; + Node7 [label="ICM20948Sensor",height=0.2,width=0.4,color="gray40", fillcolor="white", style="filled",URL="$classICM20948Sensor.html",tooltip="Driver for ICM20948."]; Node1 -> Node8 [dir="back",color="steelblue1",style="solid"]; Node8 [label="Magnetometer",height=0.2,width=0.4,color="gray40", fillcolor="white", style="filled",URL="$classMagnetometer.html",tooltip="Generic Magnetometer."]; Node1 -> Node9 [dir="back",color="steelblue1",style="solid"]; diff --git a/docs/latex/classICM20948Sensor.tex b/docs/latex/classICM20948Sensor.tex index 164226d..d0624f3 100644 --- a/docs/latex/classICM20948Sensor.tex +++ b/docs/latex/classICM20948Sensor.tex @@ -2,6 +2,15 @@ \label{classICM20948Sensor}\index{ICM20948Sensor@{ICM20948Sensor}} +Driver for ICM20948. + + + + +{\ttfamily \#include $<$ICM20948\+Sensor.\+h$>$} + + + Inheritance diagram for ICM20948\+Sensor\+: % FIG 0 @@ -12,7 +21,7 @@ \begin{DoxyCompactItemize} \item \mbox{\hyperlink{classICM20948Sensor_ad83c1c6ba1547c9e8f4d597f89782342}{ICM20948\+Sensor}} (uint8\+\_\+t chip\+Select\+Pin) -\begin{DoxyCompactList}\small\item\em Creates a \mbox{\hyperlink{classICM20948}{ICM20948}}. \end{DoxyCompactList}\item +\begin{DoxyCompactList}\small\item\em Creates a ICM20948. \end{DoxyCompactList}\item void \mbox{\hyperlink{classICM20948Sensor_a7b362848bae3009c5aa5d2eae1e3fc57}{set\+Spi\+Class}} (SPIClass $\ast$spi\+Class) \begin{DoxyCompactList}\small\item\em Sets the SPI object to use. \end{DoxyCompactList}\item void \mbox{\hyperlink{classICM20948Sensor_a21adda2cc94e08704e4c92bb4372c76e}{setup}} () final @@ -33,6 +42,11 @@ \begin{DoxyCompactList}\small\item\em Read data from the sensor. \end{DoxyCompactList}\end{DoxyCompactItemize} +\doxysubsection{Detailed Description} +Driver for ICM20948. + +Uses the sparkfun Arduino ICM20948 library, and abstracts it to our sensor formats + \doxysubsection{Constructor \& Destructor Documentation} \mbox{\Hypertarget{classICM20948Sensor_ad83c1c6ba1547c9e8f4d597f89782342}\label{classICM20948Sensor_ad83c1c6ba1547c9e8f4d597f89782342}} \index{ICM20948Sensor@{ICM20948Sensor}!ICM20948Sensor@{ICM20948Sensor}} @@ -42,7 +56,7 @@ -Creates a \mbox{\hyperlink{classICM20948}{ICM20948}}. +Creates a ICM20948. \begin{DoxyParams}{Parameters} @@ -62,7 +76,7 @@ Gets the \mbox{\hyperlink{classAccelerometer}{Accelerometer}} injector class. -Injector classes are used to pass data to the \mbox{\hyperlink{classHardwareAbstraction}{Hardware\+Abstraction}}. The \mbox{\hyperlink{classICM20948}{ICM20948}} is basically a 3 in one sensor, so we make a \char`\"{}dummy\char`\"{} class for each of the 3 sensors, and pass data through it. \begin{DoxyReturn}{Returns} +Injector classes are used to pass data to the \mbox{\hyperlink{classHardwareAbstraction}{Hardware\+Abstraction}}. The ICM20948 is basically a 3 in one sensor, so we make a \char`\"{}dummy\char`\"{} class for each of the 3 sensors, and pass data through it. \begin{DoxyReturn}{Returns} \mbox{\hyperlink{classAccelerometer}{Accelerometer}} injector class \end{DoxyReturn} \mbox{\Hypertarget{classICM20948Sensor_a0067a30feb6c7b3b637e39d52a648a2a}\label{classICM20948Sensor_a0067a30feb6c7b3b637e39d52a648a2a}} @@ -75,7 +89,7 @@ Gets the \mbox{\hyperlink{classGyroscope}{Gyroscope}} injector class. -Injector classes are used to pass data to the \mbox{\hyperlink{classHardwareAbstraction}{Hardware\+Abstraction}}. The \mbox{\hyperlink{classICM20948}{ICM20948}} is basically a 3 in one sensor, so we make a \char`\"{}dummy\char`\"{} class for each of the 3 sensors, and pass data through it. \begin{DoxyReturn}{Returns} +Injector classes are used to pass data to the \mbox{\hyperlink{classHardwareAbstraction}{Hardware\+Abstraction}}. The ICM20948 is basically a 3 in one sensor, so we make a \char`\"{}dummy\char`\"{} class for each of the 3 sensors, and pass data through it. \begin{DoxyReturn}{Returns} \mbox{\hyperlink{classGyroscope}{Gyroscope}} injector class \end{DoxyReturn} \mbox{\Hypertarget{classICM20948Sensor_acf5faa4722fc01ea6bc6c30c4fb98df9}\label{classICM20948Sensor_acf5faa4722fc01ea6bc6c30c4fb98df9}} @@ -88,7 +102,7 @@ Gets the \mbox{\hyperlink{classMagnetometer}{Magnetometer}} injector class. -Injector classes are used to pass data to the \mbox{\hyperlink{classHardwareAbstraction}{Hardware\+Abstraction}}. The \mbox{\hyperlink{classICM20948}{ICM20948}} is basically a 3 in one sensor, so we make a \char`\"{}dummy\char`\"{} class for each of the 3 sensors, and pass data through it. \begin{DoxyReturn}{Returns} +Injector classes are used to pass data to the \mbox{\hyperlink{classHardwareAbstraction}{Hardware\+Abstraction}}. The ICM20948 is basically a 3 in one sensor, so we make a \char`\"{}dummy\char`\"{} class for each of the 3 sensors, and pass data through it. \begin{DoxyReturn}{Returns} \mbox{\hyperlink{classMagnetometer}{Magnetometer}} injector class \end{DoxyReturn} \mbox{\Hypertarget{classICM20948Sensor_aa909de6c9a56db475ac4d9ab2fa97c0f}\label{classICM20948Sensor_aa909de6c9a56db475ac4d9ab2fa97c0f}} diff --git a/docs/latex/classICM20948Sensor__coll__graph.dot b/docs/latex/classICM20948Sensor__coll__graph.dot index 9cacd15..ebb7ebc 100644 --- a/docs/latex/classICM20948Sensor__coll__graph.dot +++ b/docs/latex/classICM20948Sensor__coll__graph.dot @@ -4,7 +4,7 @@ digraph "ICM20948Sensor" bgcolor="transparent"; edge [fontname=Helvetica,fontsize=10,labelfontname=Helvetica,labelfontsize=10]; node [fontname=Helvetica,fontsize=10,shape=box,height=0.2,width=0.4]; - Node1 [label="ICM20948Sensor",height=0.2,width=0.4,color="gray40", fillcolor="grey60", style="filled", fontcolor="black",tooltip=" "]; + Node1 [label="ICM20948Sensor",height=0.2,width=0.4,color="gray40", fillcolor="grey60", style="filled", fontcolor="black",tooltip="Driver for ICM20948."]; Node2 -> Node1 [dir="back",color="steelblue1",style="solid"]; Node2 [label="GenericSensor",height=0.2,width=0.4,color="gray40", fillcolor="white", style="filled",URL="$classGenericSensor.html",tooltip="Underlying interface to all sensors."]; } diff --git a/docs/latex/classICM20948Sensor__inherit__graph.dot b/docs/latex/classICM20948Sensor__inherit__graph.dot index 9cacd15..ebb7ebc 100644 --- a/docs/latex/classICM20948Sensor__inherit__graph.dot +++ b/docs/latex/classICM20948Sensor__inherit__graph.dot @@ -4,7 +4,7 @@ digraph "ICM20948Sensor" bgcolor="transparent"; edge [fontname=Helvetica,fontsize=10,labelfontname=Helvetica,labelfontsize=10]; node [fontname=Helvetica,fontsize=10,shape=box,height=0.2,width=0.4]; - Node1 [label="ICM20948Sensor",height=0.2,width=0.4,color="gray40", fillcolor="grey60", style="filled", fontcolor="black",tooltip=" "]; + Node1 [label="ICM20948Sensor",height=0.2,width=0.4,color="gray40", fillcolor="grey60", style="filled", fontcolor="black",tooltip="Driver for ICM20948."]; Node2 -> Node1 [dir="back",color="steelblue1",style="solid"]; Node2 [label="GenericSensor",height=0.2,width=0.4,color="gray40", fillcolor="white", style="filled",URL="$classGenericSensor.html",tooltip="Underlying interface to all sensors."]; } diff --git a/docs/latex/classMS8607Sensor.tex b/docs/latex/classMS8607Sensor.tex index 0a5b55a..e455f0f 100644 --- a/docs/latex/classMS8607Sensor.tex +++ b/docs/latex/classMS8607Sensor.tex @@ -2,6 +2,15 @@ \label{classMS8607Sensor}\index{MS8607Sensor@{MS8607Sensor}} +An implementation of \mbox{\hyperlink{classBarometer}{Barometer}} for the MS8607 barometer. + + + + +{\ttfamily \#include $<$MS8607\+Sensor.\+h$>$} + + + Inheritance diagram for MS8607\+Sensor\+: % FIG 0 @@ -64,6 +73,11 @@ \begin{DoxyCompactList}\small\item\em The calculated altitude. \end{DoxyCompactList}\end{DoxyCompactItemize} +\doxysubsection{Detailed Description} +An implementation of \mbox{\hyperlink{classBarometer}{Barometer}} for the MS8607 barometer. + +Uses the Spark\+Fun PHT MS8607 Arduino library and implements an abstraction layer for our format. The datasheet can be found here\+: \href{https://cdn.sparkfun.com/assets/b/a/f/b/f/MS8607_Datasheet.pdf}{\texttt{ https\+://cdn.\+sparkfun.\+com/assets/b/a/f/b/f/\+MS8607\+\_\+\+Datasheet.\+pdf}} + \doxysubsection{Member Function Documentation} \mbox{\Hypertarget{classMS8607Sensor_a762aec1b89a7b4388226bd2d6da73aac}\label{classMS8607Sensor_a762aec1b89a7b4388226bd2d6da73aac}} \index{MS8607Sensor@{MS8607Sensor}!read@{read}} diff --git a/docs/latex/classMS8607Sensor__coll__graph.dot b/docs/latex/classMS8607Sensor__coll__graph.dot index 7a4328c..5528777 100644 --- a/docs/latex/classMS8607Sensor__coll__graph.dot +++ b/docs/latex/classMS8607Sensor__coll__graph.dot @@ -4,7 +4,7 @@ digraph "MS8607Sensor" bgcolor="transparent"; edge [fontname=Helvetica,fontsize=10,labelfontname=Helvetica,labelfontsize=10]; node [fontname=Helvetica,fontsize=10,shape=box,height=0.2,width=0.4]; - Node1 [label="MS8607Sensor",height=0.2,width=0.4,color="gray40", fillcolor="grey60", style="filled", fontcolor="black",tooltip=" "]; + Node1 [label="MS8607Sensor",height=0.2,width=0.4,color="gray40", fillcolor="grey60", style="filled", fontcolor="black",tooltip="An implementation of Barometer for the MS8607 barometer."]; Node2 -> Node1 [dir="back",color="steelblue1",style="solid"]; Node2 [label="Barometer",height=0.2,width=0.4,color="gray40", fillcolor="white", style="filled",URL="$classBarometer.html",tooltip="Generic Barometer."]; Node3 -> Node2 [dir="back",color="steelblue1",style="solid"]; diff --git a/docs/latex/classMS8607Sensor__inherit__graph.dot b/docs/latex/classMS8607Sensor__inherit__graph.dot index 7a4328c..5528777 100644 --- a/docs/latex/classMS8607Sensor__inherit__graph.dot +++ b/docs/latex/classMS8607Sensor__inherit__graph.dot @@ -4,7 +4,7 @@ digraph "MS8607Sensor" bgcolor="transparent"; edge [fontname=Helvetica,fontsize=10,labelfontname=Helvetica,labelfontsize=10]; node [fontname=Helvetica,fontsize=10,shape=box,height=0.2,width=0.4]; - Node1 [label="MS8607Sensor",height=0.2,width=0.4,color="gray40", fillcolor="grey60", style="filled", fontcolor="black",tooltip=" "]; + Node1 [label="MS8607Sensor",height=0.2,width=0.4,color="gray40", fillcolor="grey60", style="filled", fontcolor="black",tooltip="An implementation of Barometer for the MS8607 barometer."]; Node2 -> Node1 [dir="back",color="steelblue1",style="solid"]; Node2 [label="Barometer",height=0.2,width=0.4,color="gray40", fillcolor="white", style="filled",URL="$classBarometer.html",tooltip="Generic Barometer."]; Node3 -> Node2 [dir="back",color="steelblue1",style="solid"]; diff --git a/docs/latex/hierarchy.tex b/docs/latex/hierarchy.tex index b6269c0..867b411 100644 --- a/docs/latex/hierarchy.tex +++ b/docs/latex/hierarchy.tex @@ -27,8 +27,6 @@ \item \contentsline{section}{Pyro}{\pageref{classPyro}}{} \end{DoxyCompactList} \item \contentsline{section}{Hardware\+Abstraction}{\pageref{classHardwareAbstraction}}{} -\item \contentsline{section}{ICM20948}{\pageref{classICM20948}}{} \item \contentsline{section}{Logger}{\pageref{classLogger}}{} -\item \contentsline{section}{MS8607driver}{\pageref{classMS8607driver}}{} \item \contentsline{section}{Vector3\+D\+\_\+s}{\pageref{structVector3D__s}}{} \end{DoxyCompactList} diff --git a/docs/latex/refman.tex b/docs/latex/refman.tex index fe142a9..36724ef 100644 --- a/docs/latex/refman.tex +++ b/docs/latex/refman.tex @@ -204,11 +204,9 @@ \chapter{Class Documentation} \input{classGPS} \input{classGyroscope} \input{classHardwareAbstraction} -\input{classICM20948} \input{classICM20948Sensor} \input{classLogger} \input{classMagnetometer} -\input{classMS8607driver} \input{classMS8607Sensor} \input{classPyro} \input{classRadioTransmitterLink} diff --git a/platformio_nuli_avionics_flight_software/include/ICM20948Sensor.h b/platformio_nuli_avionics_flight_software/include/ICM20948Sensor.h index 0faf827..302282b 100644 --- a/platformio_nuli_avionics_flight_software/include/ICM20948Sensor.h +++ b/platformio_nuli_avionics_flight_software/include/ICM20948Sensor.h @@ -9,7 +9,7 @@ #include /** - * @class ICM20948 + * @class ICM20948Sensor * @brief Driver for ICM20948 * @details Uses the sparkfun Arduino ICM20948 library, and abstracts it to our sensor formats */ diff --git a/platformio_nuli_avionics_flight_software/include/MS8607Sensor.h b/platformio_nuli_avionics_flight_software/include/MS8607Sensor.h index e630f91..8004f7c 100644 --- a/platformio_nuli_avionics_flight_software/include/MS8607Sensor.h +++ b/platformio_nuli_avionics_flight_software/include/MS8607Sensor.h @@ -7,7 +7,7 @@ #include // library for MS8607 /** - * @class MS8607driver + * @class MS8607Sensor * @brief An implementation of Barometer for the MS8607 barometer. * @details Uses the SparkFun PHT MS8607 Arduino library and implements an abstraction layer for our format. * The datasheet can be found here: https://cdn.sparkfun.com/assets/b/a/f/b/f/MS8607_Datasheet.pdf