0.3.0 MS5837

Author: RobTillaart

libraries/MS5837/.github/workflows/arduino-lint.yml

@@ -6,9 +6,8 @@ jobs:
  runs-on: ubuntu-latest
  timeout-minutes: 5
  steps:
- - uses: actions/checkout@v4
- - uses: arduino/arduino-lint-action@v1
+ - uses: actions/checkout@v5
+ - uses: arduino/arduino-lint-action@v2
  with:
  library-manager: update
- compliance: strict
-
+ compliance: strict

libraries/MS5837/.github/workflows/arduino_test_runner.yml

@@ -8,11 +8,10 @@ jobs:
  timeout-minutes: 20
 
  steps:
- - uses: actions/checkout@v4
+ - uses: actions/checkout@v5
  - uses: ruby/setup-ruby@v1
  with:
  ruby-version: 2.6
  - run: |
- sudo sysctl vm.mmap_rnd_bits=28
  gem install arduino_ci
  arduino_ci.rb

libraries/MS5837/.github/workflows/jsoncheck.yml

@@ -5,13 +5,15 @@ on:
  paths:
  - '**.json'
  pull_request:
+ paths:
+ - '**.json'
 
 jobs:
  test:
  runs-on: ubuntu-latest
  timeout-minutes: 5
  steps:
- - uses: actions/checkout@v4
+ - uses: actions/checkout@v5
  - name: json-syntax-check
  uses: limitusus/json-syntax-check@v2
  with:

libraries/MS5837/CHANGELOG.md

@@ -6,9 +6,20 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 
+## [0.3.0] - 2025-09-27
+- sync MS5611
+- add getAltitudeFeet()
+- add getDepthFeet()
+- add getPressurePascal()
+- update GitHub actions
+- update README.md
+- minor edits
+
+----
+
 ## [0.2.0] - 2025-06-13
 - fix #4, read() error after test with hardware
-- change API to **int read()** for better debugability
+- change API to **int read()** for better debug-ability
 - improve demo sketch - add getLastError()
 - redo getAltitude() formula 
 - add sketch MS5837_performance.ino

libraries/MS5837/MS5837.cpp

@@ -1,7 +1,7 @@
 //
 // FILE: MS5837.cpp
 // AUTHOR: Rob Tillaart
-// VERSION: 0.2.0
+// VERSION: 0.3.0
 // DATE: 2023-11-12
 // PURPOSE: Arduino library for MS5837 temperature and pressure sensor.
 // URL: https://github.com/RobTillaart/MS5837
@@ -110,7 +110,6 @@ int MS5837::read(uint8_t bits)
  }
 
  uint32_t start = millis();
-
  // while loop prevents blocking RTOS
  while (millis() - start < wait)
  {
@@ -232,15 +231,21 @@ uint32_t MS5837::lastRead()
 }
 
 
+float MS5837::getTemperature()
+{
+ return _temperature;
+}
+
+
 float MS5837::getPressure()
 {
  return _pressure;
 }
 
 
-float MS5837::getTemperature()
+float MS5837::getPressurePascal()
 {
- return _temperature;
+ return _pressure * 100.0;
 }
 
 
@@ -249,11 +254,19 @@ float MS5837::getTemperature()
 // https://en.wikipedia.org/wiki/Pressure_altitude
 float MS5837::getAltitude(float airPressure)
 {
+ // _pressure is in mBar - differs from MS5611
  float ratio = _pressure / airPressure;
  return 44307.694 * (1 - pow(ratio, 0.190284));
 }
 
 
+float MS5837::getAltitudeFeet(float airPressure)
+{
+ float ratio = _pressure / airPressure;
+ return 145366.45 * (1 - pow(ratio, 0.190284));
+}
+
+
 //////////////////////////////////////////////////////////////////////
 //
 // DENSITY for depth
@@ -279,6 +292,13 @@ float MS5837::getDepth(float airPressure)
  return (_pressure - airPressure)/(_density * 9.80665 * 10);
 }
 
+float MS5837::getDepthFeet(float airPressure)
+{
+ // optimized
+ return 0.033455768 * (_pressure - airPressure)/_density;
+ // return getDepth() * 3.2808399;
+}
+
 
 //////////////////////////////////////////////////////////////////////
 //

libraries/MS5837/MS5837.h

@@ -2,7 +2,7 @@
 //
 // FILE: MS5837.h
 // AUTHOR: Rob Tillaart
-// VERSION: 0.2.0
+// VERSION: 0.3.0
 // DATE: 2023-11-12
 // PURPOSE: Arduino library for MS5837 temperature and pressure sensor.
 // URL: https://github.com/RobTillaart/MS5837
@@ -12,7 +12,7 @@
 #include "Wire.h"
 
 
-#define MS5837_LIB_VERSION (F("0.2.0"))
+#define MS5837_LIB_VERSION (F("0.3.0"))
 
 
 // TYPES
@@ -55,15 +55,22 @@ class MS5837
  int read(uint8_t bits = 8);
  uint32_t lastRead();
 
- // see https://github.com/RobTillaart/pressure for conversions.
- // returns mBar
- float getPressure();
  // see https://github.com/RobTillaart/temperature for conversions.
  // returns Celsius
  float getTemperature();
+ // see https://github.com/RobTillaart/pressure for conversions.
+ // returns mBar
+ float getPressure();
  // compensate for actual air pressure if needed
  // returns meters.
+ // pressure is in Pascal (SI-unit)
+ float getPressurePascal();
+ //
+ // ALTITUDE
+ // air pressure in mBar, returns meters
  float getAltitude(float airPressure = 1013.25);
+ // idem, returns feet.
+ float getAltitudeFeet(float airPressure = 1013.25);
 
 
  //////////////////////////////////////////////////////////////////////
@@ -78,9 +85,12 @@ class MS5837
  // density in grams / cm3 (so not in grams per liter
  void setDensity(float density = 0.99802);
  float getDensity();
- // returns meters (SI unit)
- // compensate for actual air pressure if needed
+ //
+ // returns meters (SI unit)
+ // compensate for actual air pressure if needed
  float getDepth(float airPressure = 1013.25);
+ // idem, returns feet.
+ float getDepthFeet(float airPressure = 1013.25);
 
 
  //////////////////////////////////////////////////////////////////////
@@ -108,8 +118,8 @@ class MS5837
  uint8_t _address = 0x76;
  TwoWire * _wire = NULL;
 
- float _pressure;
- float _temperature;
+ float _pressure; // mBar
+ float _temperature; // Celsius
 
  float C[8];
  uint8_t _type = MS5837_TYPE_UNKNOWN;

libraries/MS5837/README.md

@@ -179,15 +179,20 @@ The call will block for 3 to 40 milliseconds, depending upon number of bits.
 - **uint32_t lastRead()** returns the timestamp of the last call to read() in 
 milliseconds since start. 
 It does not take into account if the read call is successful or not.
+- **float getTemperature()** returns temperature in degrees Celsius.
+Multiple calls will return the same value until read() is called again.
 - **float getPressure()** returns pressure in mBar.
 Multiple calls will return the same value until read() is called again.
-- **float getTemperature()** returns temperature in degrees Celsius.
+- **float getPressurePascal()** returns pressure in Pascal (SI-unit).
 Multiple calls will return the same value until read() is called again.
 - **float getAltitude(float airPressure = 1013.25)** calculates the altitude,
-based upon actual pressure measured and the current pressure at sea level.
-Returns the altitude in meters.
-Multiple calls will return the same value until read() is called again.
-One can compensate for the actual air pressure at sea level.
+based upon actual pressure measured and the current pressure at sea level (parameter airPressure).
+Returns the altitude in meters (SI-unit).
+Multiple calls will return the same altitude until a new pressure is **read()**.
+- **float getAltitudeFeet(float airPressure = 1013.25)** calculates the altitude,
+based upon actual pressure measured and the current pressure at sea level (parameter airPressure).
+Returns the altitude in feet.
+Multiple calls will return the same altitude until a new pressure is **read()**.
 
 Experimental note.
 
@@ -215,7 +220,12 @@ density water 20°C = 0.99802
 - **float getDensity()** returns set liquid density.
 - **float getDepth(float airPressure = 1013.25)** calculates the depth, 
 based upon actual pressure and the pressure at sea level.
-Returns depth in meters.
+Returns depth in meters (SI-unit).
+One can compensate for the actual air pressure at sea level.
+Multiple calls will return the same value until read() is called again.
+- **float getDepthFeet(float airPressure = 1013.25)** calculates the depth, 
+based upon actual pressure and the pressure at sea level.
+Returns depth in feet.
 One can compensate for the actual air pressure at sea level.
 Multiple calls will return the same value until read() is called again.
 

libraries/MS5837/keywords.txt

@@ -14,19 +14,23 @@ getAddress	KEYWORD2
 read	KEYWORD2
 lastRead	KEYWORD2
 
-getPressure	KEYWORD2
 getTemperature	KEYWORD2
+getPressure	KEYWORD2
+getPressurePascal	KEYWORD2
 getAltitude	KEYWORD2
+getAltitudeFeet	KEYWORD2
 
 setDensity	KEYWORD2
 getDensity	KEYWORD2
 getDepth	KEYWORD2
+getDepthFeet	KEYWORD2
 
 getLastError	KEYWORD2
 
 getCRC	KEYWORD2
 getProduct	KEYWORD2
 getFactorySettings	KEYWORD2
+getPromZero	KEYWORD2
 
 
 # Constants (LITERAL1)
@@ -37,6 +41,7 @@ MS5803_TYPE_01	LITERAL1
 MS5837_TYPE_02	LITERAL1
 MS5837_TYPE_30	LITERAL1
 
-
 MS5837_OK	LITERAL1
+MS5837_ERROR_I2C	LITERAL1
+MS5837_ERROR_REQUEST	LITERAL1
 

libraries/MS5837/library.json

@@ -1,6 +1,6 @@
 {
  "name": "MS5837",
- "keywords": "MS5837, MS5803, temperature, pressure",
+ "keywords": "MS5837, MS5803, temperature, pressure,altitude,depth",
  "description": "Arduino library for MS5837 temperature and pressure sensor.",
  "authors":
  [
@@ -15,7 +15,7 @@
  "type": "git",
  "url": "https://github.com/RobTillaart/MS5837.git"
  },
- "version": "0.2.0",
+ "version": "0.3.0",
  "license": "MIT",
  "frameworks": "*",
  "platforms": "*",

libraries/MS5837/library.properties

@@ -1,9 +1,9 @@
 name=MS5837
-version=0.2.0
+version=0.3.0
 author=Rob Tillaart <rob.tillaart@gmail.com>
 maintainer=Rob Tillaart <rob.tillaart@gmail.com>
 sentence=Arduino library for MS5837 temperature and pressure sensor.
-paragraph=MS5803
+paragraph=MS5803,altitude,depth
 category=Sensors
 url=https://github.com/RobTillaart/MS5837
 architectures=*