Allow custom I²C address, rename calibration date variables

Author: Granjow

README.md

@@ -1,5 +1,23 @@
 # BlueRobotics_KellerLD_Library
 
-Arduino library for the Keller 4LD - 9LD I2C pressure and temperature sensors; used in the Bar100 Sensor from Blue Robotics.
+Arduino library for the Keller 4LD to 9LD I²C pressure and temperature sensors;
+used in the Bar100 Sensor from Blue Robotics.
 
-See the [Keller Communication Protocol 4LD-9LD](http://www.keller-druck2.ch/swupdate/InstallerD-LineAddressManager/manual/Communication_Protocol_4LD-9LD_en.pdf) document for more details on the I<sup>2</sup>C communication protocol, and the [Keller 4LD-9LD Datasheet](https://download.keller-druck.com/api/download/2LfcGMzMbeHdjFbyUd5DWA/en/latest) for sensor specification details.
+See the [Keller Communication Protocol 4LD-9LD][com] document for more details
+on the I²C communication protocol, and the [Keller 4LD-9LD
+Datasheet][datasheet] for sensor specification details.
+
+[com]: http://www.keller-druck2.ch/swupdate/InstallerD-LineAddressManager/manual/Communication_Protocol_4LD-9LD_en.pdf
+[datasheet]: https://download.keller-druck.com/api/download/2LfcGMzMbeHdjFbyUd5DWA/en/latest
+
+## Changelog
+
+* `2.0.0`
+  * Allow user-defined I²C address for the sensor
+  * Calibration date fields renamed to `calibration{Year,Month,Day}`
+* `1.1.0` (2021-07-01)
+  * Add P-mode pressure offset handling for PR, PA and PAA type sensors,
+    auto-determined based on sensor mode
+  * Add support to read out the calibration date
+* `1.0.0` (2017-08-31)
+  * Initial release.

library.properties

@@ -1,5 +1,5 @@
 name=BlueRobotics Keller LD Library
-version=1.1.1
+version=2.0.0
 author=BlueRobotics
 maintainer=BlueRobotics <[email protected]>
 sentence=A simple and easy library for the Keller LD series pressure/depth sensors

src/KellerLD.cpp

@@ -1,7 +1,7 @@
 #include "KellerLD.h"
 #include <Wire.h>
 
-#define LD_ADDR                     0x40
+#define LD_DEFAULT_ADDR             0x40
 #define LD_REQUEST                  0xAC
 #define LD_CUST_ID0                 0x00
 #define LD_CUST_ID1                 0x01
@@ -11,8 +11,13 @@
 #define LD_SCALING3                 0x15
 #define LD_SCALING4                 0x16
 
-KellerLD::KellerLD() {
-	fluidDensity = 1029;
+
+KellerLD::KellerLD()
+		: i2cAddress(LD_DEFAULT_ADDR) {
+}
+
+KellerLD::KellerLD(int i2cAddress)
+		: i2cAddress(i2cAddress) {
 }
 
 void KellerLD::init() {
@@ -29,12 +34,11 @@ void KellerLD::init() {
 	scaling0 = readMemoryMap(LD_SCALING0);
 
 	mode = scaling0 & 0b00000011;
-	year = scaling0 >> 11;
-	month = (scaling0 & 0b0000011110000000) >> 7;
-	day = (scaling0 & 0b0000000001111100) >> 2;
+	calibrationYear = scaling0 >> 11;
+	calibrationMonth = (scaling0 & 0b0000011110000000) >> 7;
+	calibrationDay = (scaling0 & 0b0000000001111100) >> 2;
 
 	// handle P-mode pressure offset (to vacuum pressure)
-
 	if (mode == 0) {
 		// PA mode, Vented Gauge. Zero at atmospheric pressure
 		P_mode = 1.01325;
@@ -63,13 +67,13 @@ void KellerLD::setFluidDensity(float density) {
 void KellerLD::read() {
 	uint8_t status;
 
-	Wire.beginTransmission(LD_ADDR);
+	Wire.beginTransmission(i2cAddress);
 	Wire.write(LD_REQUEST);
 	Wire.endTransmission();
 
 	delay(9); // Max conversion time per datasheet
 
-	Wire.requestFrom(LD_ADDR, 5);
+	Wire.requestFrom(i2cAddress, 5);
 	status = Wire.read();
 	P = (Wire.read() << 8) | Wire.read();
 	uint16_t T = (Wire.read() << 8) | Wire.read();
@@ -81,13 +85,13 @@ void KellerLD::read() {
 uint16_t KellerLD::readMemoryMap(uint8_t mtp_address) {
 	uint8_t status;
 
-	Wire.beginTransmission(LD_ADDR);
+	Wire.beginTransmission(i2cAddress);
 	Wire.write(mtp_address);
 	Wire.endTransmission();
 
 	delay(1); // allow for response to come in
 
-	Wire.requestFrom(LD_ADDR, 3);
+	Wire.requestFrom(i2cAddress, 3);
 	status = Wire.read();
 	return ((Wire.read() << 8) | Wire.read());
 }

src/KellerLD.h

@@ -45,6 +45,8 @@ class KellerLD {
 
 	KellerLD();
 
+	explicit KellerLD(int i2cAddress);
+
   /** Reads the onboard memory map to determine min and max pressure as 
    *  well as manufacture date, mode, and customer ID.
    */
@@ -90,9 +92,9 @@ class KellerLD {
 	uint16_t file;
 
 	uint8_t mode;
-	uint16_t year;
-	uint8_t month;
-	uint8_t day;
+	uint16_t calibrationYear;
+	uint8_t calibrationMonth;
+	uint8_t calibrationDay;
 
 	uint32_t code;
 
@@ -103,7 +105,7 @@ class KellerLD {
 	float P_max;
 
 private:
-	float fluidDensity;
+	float fluidDensity = 1029;
 	float T_degc;
 
 	uint16_t cust_id0;

src/main.cpp

@@ -1,7 +1,7 @@
 #include "Arduino.h"
 #include "KellerLD.h"
 
-KellerLD sensor;
+KellerLD sensor(0x61);
 
 void setup() {
 }