diff --git a/README_EN.md b/README_EN.md index 96de354..3ff2e53 100644 --- a/README_EN.md +++ b/README_EN.md @@ -1,130 +1,146 @@ This is an automatic translation, may be incorrect in some places. See sources and examples! -# GyverBME280 -Lightweight BME280 I2C library for Arduino +# Gyverbme280 +Light library for working with BME280 on I2C for Arduino -### Compatibility -Compatible with all Arduino platforms (using Arduino functions) +## compatibility +Compatible with all arduino platforms (used arduino functions) ## Content -- [Install](#install) -- [Initialization](#init) -- [Usage](#usage) -- [Example](#example) -- [Versions](#versions) -- [Bugs and feedback](#feedback) +- [installation] (# Install) +- [initialization] (#init) +- [use] (#usage) +- [Example] (# Example) +- [versions] (#varsions) +- [bugs and feedback] (#fedback) - + ## Installation -- The library can be found by the name **GyverBME280** and installed via the library manager in: - - Arduino IDE - - Arduino IDE v2 - - PlatformIO -- [Download library](https://github.com/GyverLibs/GyverBME280/archive/refs/heads/main.zip) .zip archive for manual installation: - - Unzip and put in *C:\Program Files (x86)\Arduino\libraries* (Windows x64) - - Unzip and put in *C:\Program Files\Arduino\libraries* (Windows x32) - - Unpack and put in *Documents/Arduino/libraries/* - - (Arduino IDE) automatic installation from .zip: *Sketch/Include library/Add .ZIP library…* and specify the downloaded archive -- Read more detailed instructions for installing libraries [here] (https://alexgyver.ru/arduino-first/#%D0%A3%D1%81%D1%82%D0%B0%D0%BD%D0%BE% D0%B2%D0%BA%D0%B0_%D0%B1%D0%B8%D0%B1%D0%BB%D0%B8%D0%BE%D1%82%D0%B5%D0%BA) +- The library can be found by the name ** gyverbme280 ** and installed through the library manager in: + - Arduino ide + - Arduino ide v2 + - Platformio +- [download library] (https://github.com/gyverlibs/gyverbme280/archive/refs/heads/main.zip). Zip archive for manual installation: + - unpack and put in * C: \ Program Files (X86) \ Arduino \ Libraries * (Windows X64) + - unpack and put in * C: \ Program Files \ Arduino \ Libraries * (Windows X32) + - unpack and put in *documents/arduino/libraries/ * + - (Arduino id) Automatic installation from. Zip: * sketch/connect the library/add .Zip library ... * and specify downloaded archive +- Read more detailed instructions for installing libraries [here] (https://alexgyver.ru/arduino-first/#%D0%A3%D1%81%D1%82%D0%B0%BD%D0%BE%BE%BE%BED0%B2%D0%BA%D0%B0_%D0%B1%D0%B8%D0%B1%D0%BB%D0%B8%D0%BE%D1%82%D0%B5%D0%BA) +### Update +- I recommend always updating the library: errors and bugs are corrected in the new versions, as well as optimization and new features are added +- through the IDE library manager: find the library how to install and click "update" +- Manually: ** remove the folder with the old version **, and then put a new one in its place.“Replacement” cannot be done: sometimes in new versions, files that remain when replacing are deleted and can lead to errors! - -## Initialization -```cpp -GyverBME280 bme; -``` - + +## initialization +`` `CPP +Gyverbme280 BME; +`` ` + + ## Usage -```cpp -boolbegin(void); // run with standard addresscatfish (0x76) -bool begin(uint8_t address); // run with address -bool isMeasuring(void); // returns true while the measurement is in progress -float readPressure(void); // read pressure in Pa -float readHumidity(void); // Read humidity in % -void oneMeasurement(void); // Take one measurement and go to sleep -float readTemperature(void); // Read temperature in degrees C +`` `CPP +Bool Begin (VOID);// Launch with a standard address (0x76) +Bool Begin (Uint8_T Address);// Launch addressing the address +Bool ISMEASURING (VOID);// returns True while the measurement is underway +Float Readpressure (Void);// Read the pressure in PA +Float Readhumidity (VOID);// read humidity in % +VOID OneMeasurement (VOID);// make one dimension and go into a dream +Float ReadTemperature (VOID);// Read the temperature in degrees with -void setMode(uint8_tmode); // set the mode of operation +VOID setmode (uint8_t mode);// set the operating mode // modes: -NORMAL_MODE -FORCED_MODE +Normal_Mode +Forced_Mode -void setFilter(uint8_tmode); // change the filter factor. Call before begin +VOID SetFilter (Uint8_t Mode);// Change the filtration coefficient.Call before Begin // coefficients: -FILTER_DISABLE -FILTER_COEF_2 -FILTER_COEF_4 -FILTER_COEF_8 -FILTER_COEF_16 +Filter_disable +Filter_coEF_2 +Filter_coEF_4 +Filter_coEF_8 +Filter_coEF_16 -void setStandbyTime(uint8_tmode); // Change time between measurements. Call before begin +VOID SetstandbyTime (Uint8_t Mode);// Change the time between measurements.Call before Begin // modes: -STANDBY_500US -STANDBY_10MS -STANDBY_20MS -STANDBY_6250US -STANDBY_125MS -STANDBY_250MS -STANDBY_500MS -STANDBY_1000MS +Standby_500us +Standby_10ms +Standby_20ms +Standby_6250us +Standby_125MS +Standby_250MS +Standby_500ms +Standby_1000ms -void setHumOversampling(uint8_t mode); // Set up oversampling or disable humidity. Call before begin -void setTempOversampling(uint8_t mode); // Set up oversampling or disable temperature. Call before begin -void setPressOversampling(uint8_t mode); // Set up oversampling or disable pressure. Call before begin +VOID sethumoversampling (Uint8_t Mode);// Configure oversemling or turn off humidity.Call before Begin +VOID settempoVersampling (Uint8_t Mode);// Configure oversemling or turn off the temperature.Call before Begin +VOID SetPressoversampling (Uint8_t Mode);// configure oversemling or disconnect dCranberry.Call before Begin // modes: -MODULE_DISABLE -OVERSAMPLING_1 -OVERSAMPLING_2 -OVERSAMPLING_4 -OVERSAMPLING_8 -OVERSAMPLING_16 -``` +Module_disable +Oversampling_1 +Oversampling_2 +Oversampling_4 +Oversampling_8 +Oversampling_16 +`` ` - + ## Example -See **examples** for other examples! -```cpp +The rest of the examples look at ** Examples **! +`` `CPP /* - A simple example showing the basic functions of measuring temperature, pressure and humidity + A simple example, demonstrating the basic functions of measuring temperature, pressure and humidity */ -#include // Including the library -GyverBME280 bme; // Create bme object +#incLude // Library connection +Gyverbme280 BME;// Creating a BME Object -void setup() { - Serial.begin(9600); // Start serial port - bme.begin(); // If add. settings are not needed - initialize the sensor +VOID setup () { + Serial.Begin (9600);// launch of the sequential port + bme.begin ();// if additional.Settings are not needed - initialize the sensor } -void loop() {Serial.print("Temperature: "); - Serial.print(bme.readTemperature()); // Print temperature in [*C] - Serial.println("*C"); +VOID loop () { + Serial.print ("Temperature:"); + Serial.print (BME.Readtemperature ());// We display the temporary core in [*c] + Serial.println (" *c"); - Serial.print("Humidity: "); - Serial.print(bme.readHumidity()); // Output humidity in [%] - Serial.println("%"); + Serial.print ("Humidity:"); + Serial.print (bme.readhumidity ());// We display humidity in [%] + Serial.println (" %"); - float pressure = bme.readPressure(); // Read pressure in [Pa] - Serial.print("Pressure: "); - Serial.print(pressure / 100.0F); // Display pressure in [hPa] - Serial.print(" hPa , "); - Serial.print(pressureToMmHg(pressure)); // Output pressure in [mmHg. pillar] - Serial.println("mm hg"); - Serial.print("Altide: "); - Serial.print(pressureToAltitude(pressure)); // Print height in [m a.s.l. seas] - Serial.println("m"); - Serial.println(""); - delay(1000); + Float Pressure = Bme.Readpressure ();// read pressure in [pa] + Serial.print ("Pressure:"); + Serial.print (Pressure / 100.0F);// Removing pressure in [GPA] + Serial.print ("hpa,"); + Serial.print (Pressuretommhg (Pressure));// Removing the pressure in [mm RT.pillar] + Serial.println ("MM HG"); + Serial.print ("altitide:"); + Serial.print// We display height B [m above the ur.seas] + Serial.println ("m"); + Serial.println (""); + DELAY (1000); } -``` +`` ` - -## Versions -- v1.3 - fixed bug when negative. temperature -- v1.4 - split into h and cpp -- v1.5 - added support for BMP280 + +## versions +- V1.3 - Fixed error when ledge.temperature +- v1.4 - divided into h and CPP +- V1.5 - Added BMP280 support - -## Bugs and feedback -When you find bugs, create an **Issue**, or better, immediately write to the mail [alex@alexgyver.ru](mailto:alex@alexgyver.ru) -The library is open for revision and your **Pull Request**'s! \ No newline at end of file + +## bugs and feedback +Create ** Issue ** when you find the bugs, and better immediately write to the mail [alex@alexgyver.ru] (mailto: alex@alexgyver.ru) +The library is open for refinement and your ** pull Request ** 'ow! + + +When reporting about bugs or incorrect work of the library, it is necessary to indicate: +- The version of the library +- What is MK used +- SDK version (for ESP) +- version of Arduino ide +- whether the built -in examples work correctly, in which the functions and designs are used, leading to a bug in your code +- what code has been loaded, what work was expected from it and how it works in reality +- Ideally, attach the minimum code in which the bug is observed.Not a canvas of a thousand lines, but a minimum code \ No newline at end of file