Feat ph #1

yurybotov · 2020-10-22T12:32:33Z

PH library with calibration example

Worked properly

API_ru.md

examples/calibrate/calibrate.ino

examples/using/using.ino

src/troykaph.cpp

examples/using/using.ino

src/troykaph.cpp

src/troykaph.h

red-faced Co-authored-by: AlexErAmp <[email protected]>

Co-authored-by: AlexErAmp <[email protected]>

yurybotov · 2020-11-10T16:21:20Z

Please pay attention to the clarity of the dialog with the user in the calibrate example

AlexErAmp · 2020-11-11T10:43:46Z

examples/using/using.ino

+    // phMeter.begin(correction,zeroShift); // if you have it (use calibrate.ino) for it
+
+    Serial.begin(9600);
+    showingTime = millis() + INTERVAL; // show result once per 3 seconds


No, I didn't mean it:) Use the classic millis() pattern:

Suggested change

showingTime = millis() + INTERVAL; // show result once per 3 seconds

constexpr uint32_t interval = 3000;

void setup() {

...

showingTime = millis();

}

void loop() {

...

if (millis() - showingTime >= interval) {

showingTime = millis();

...

}

}

Done with small corrections

nomad605dis

Made edits and comments

nomad605dis · 2020-11-12T03:36:26Z

src/troykaph.cpp

+ * License: GPLv3, all text here must be included in any redistribution.
+ */
+
+#include "TroykaPH.h"


Arduino IDE does not compile example:
error: troykaph.h: No such file or directory

Rename files from troykaph.cpp and troykaph.h to TroykaPH.cpp and TroykaPH.h

src/troykaph.cpp

nomad605dis · 2020-11-12T03:46:37Z

src/troykaph.cpp

+    if (millis() - _nextMeasureTime > periodMilliseconds) {
+        _nextMeasureTime += periodMilliseconds;
+        // read value
+        (void)analogRead(_pin);


Suggested change

(void)analogRead(_pin);

(void)analogRead(_pin);

Why?

Googling showed that in cases where greater accuracy is needed, you must first make an empty read so that the internal analog multiplexer switches to the desired channel, and only after a pause, when the internal capacitor voltage value stabilizes, read real data.

nomad605dis · 2020-11-12T03:49:12Z

examples/using/using.ino

+/*
+  This example demonstrate pH value reading
+*/
+#include "Arduino.h"


Suggested change

#include "Arduino.h"

#include "Arduino.h"

Why are you include Arduino.h in the example?

My compiler (under linux) swore at millis

nomad605dis · 2020-11-12T03:52:40Z

examples/using/using.ino

@@ -0,0 +1,31 @@
+/*


I think an example should be called simpleReadPH

Good idea. Done.

nomad605dis · 2020-11-12T04:00:13Z

examples/calibrate/calibrate.ino

+        Serial.println("Recalibration is needed if you change Arduino board to another.\n\n");
+        delay(5000);
+    }
+}


Why did you use microcontroller registers? After all, the calibration example won't work with the Arduino Due and ESP8226 boards?

In the standard Arduino API, there is no way to read the voltage at the internal Vref. There is only a way to use it instead of Aref. Now, as you can see, there is a way only for different AVRs. The options for other controllers can be worked on in the next version.

I propose to write from which boards support the calibration process. And there are no other options easier than using Vref?

nomad605dis · 2020-11-12T04:06:39Z

examples/using/using.ino

+        Serial.print(phMeter.read(), 1);
+        showingTime += INTERVAL;
+    }
+}


How the example works? Why not do it in our standard way?

void loop() { // Read the sensor data values PH phMeter.read(); // Receive the stored PH float valuePH = phMeter.getPH(); // Print results Serial.print("PH Value = "); Serial.println(valuePH); // Wait 1000 ms delay(1000); }

It makes no sense to constantly poll the pH sensor. First, its meaning changes very slowly. Secondly, it's a long time, there are a lot of delays when reading. Therefore, it makes sense to read from time to time, and return the last read value upon request. As here.

Co-authored-by: Igor <[email protected]>

Git dont want rename capital change only

This reverts commit f2fc42d.

nomad605dis

Made a new batch of edits.
Please also add:

There is a potentiometer on the board and why is it needed?
For calibration, you need two buffer solutions, one of which should be about 7PH.

nomad605dis · 2020-11-12T20:47:56Z

src/TroykaPH.h

+/*
+ * This file is a part of TroykaPH library.
+ *
+ * Product page: https://amperka.ru/product/zelo-folow-line-sensor


Suggested change

* Product page: https://amperka.ru/product/zelo-folow-line-sensor

* Product page: https://amperka.ru/product/troyka-ph-sensor

nomad605dis · 2020-11-12T21:14:25Z

examples/simpleReadPH/simpleReadPH.ino

+// Include library
+#include "TroykaPH.h"
+
+TroykaPH phMeter(A4); // set used analog pin


Suggested change

TroykaPH phMeter(A4); // set used analog pin

TroykaPH phMeter(A0); // set used analog pin

I suggest using pin A0, it is used everywhere by default.

nomad605dis · 2020-11-12T21:20:10Z

examples/simpleReadPH/simpleReadPH.ino

+    if (currentTime - lastShowingTime > INTERVAL) {
+        lastShowingTime = currentTime;
+        Serial.print("\nCurrent pH: ");
+        Serial.print(phMeter.read(), 1);


Suggested change

Serial.print(phMeter.read(), 1);

Serial.print(phMeter.read());

Serial.println();

Two decimal places is normal for solutions of PH.

nomad605dis · 2020-11-12T21:20:21Z

examples/simpleReadPH/simpleReadPH.ino

+
+    if (currentTime - lastShowingTime > INTERVAL) {
+        lastShowingTime = currentTime;
+        Serial.print("\nCurrent pH: ");


Suggested change

Serial.print("\nCurrent pH: ");

Serial.print("Current pH: ");

For Arduino users, it is better to do a newline at the end of the output:
Serial.println()

nomad605dis · 2020-11-12T21:28:51Z

src/TroykaPH.cpp

+    constexpr float idealVcc = 5.0;
+    constexpr float minPh = 0.0;
+    constexpr float maxPh = 14.0;
+    constexpr float phHalfRangeInVolts = 0.82;


I suggest putting all the constants into a file TroykaPH.h

nomad605dis · 2020-11-12T21:30:33Z

src/TroykaPH.h

+public:
+    TroykaPH(uint8_t pin);
+    void begin(float correction = 1.0, float zeroLevel = 2.0);
+


Why is there an empty line between functions?

nomad605dis · 2020-11-12T21:33:46Z

src/TroykaPH.cpp

+        for (uint8_t i = 0; i < 10; i++) {
+            value += (float)analogRead(_pin) * 5.0 / 1024.;
+        }
+        value = value / 10;


Suggested change

value = value / 10;

value =/ 10;

Reduce the expression?

nomad605dis · 2020-11-12T21:35:54Z

src/TroykaPH.cpp

+    constexpr float adcResolution = 1024.;
+    constexpr float meanReferenceVoltage = 1.1;
+    constexpr long toMillivolts = 1000L;
+


Similarly, I suggest putting all the constants into a file TroykaPH.h

nomad605dis · 2020-11-12T21:54:51Z

examples/calibrate/calibrate.ino

+  правые дополнить нулями.
+
+*/
+


I suggest using only one language in comments.

nomad605dis · 2020-11-12T22:01:29Z

examples/calibrate/calibrate.ino

+        Serial.println("Recalibration is needed if you change Arduino board to another.\n\n");
+        delay(5000);
+    }
+}


I propose to write from which boards support the calibration process. And there are no other options easier than using Vref?

yurybotov added 9 commits October 21, 2020 19:04

add .clang-format

554e6e1

add library properties

c21f4d5

add draft source

be80fdd

add using example

27e3c4f

add calibration procedure

e5423cb

add API_ru.md

2cc9aad

remove spaces

2645fa9

fixes

3efc6c2

fully rewrite

958c3fa

Worked properly

yurybotov requested review from nomad605dis and AlexErAmp October 22, 2020 12:32

AlexErAmp requested changes Nov 10, 2020

View reviewed changes

yurybotov and others added 8 commits November 10, 2020 18:21

Update API_ru.md

1d7c435

red-faced Co-authored-by: AlexErAmp <[email protected]>

multiplier

47db389

Co-authored-by: AlexErAmp <[email protected]>

Update examples/calibrate/calibrate.ino

bb29269

Co-authored-by: AlexErAmp <[email protected]>

Update examples/calibrate/calibrate.ino

96cccbe

Co-authored-by: AlexErAmp <[email protected]>

Update examples/using/using.ino

ad8d3c1

Co-authored-by: AlexErAmp <[email protected]>

Update src/troykaph.cpp

e21475e

Co-authored-by: AlexErAmp <[email protected]>

rename and eol in eof

fd1a8e1

other overtime record

aeeb3ad

yurybotov requested a review from AlexErAmp November 10, 2020 16:21

add keyword.txt

e3c27c9

AlexErAmp requested changes Nov 11, 2020

View reviewed changes

nomad605dis reviewed Nov 12, 2020

View reviewed changes

yurybotov and others added 5 commits November 12, 2020 11:57

copy-past

5b1ef10

Co-authored-by: Igor <[email protected]>

Dummy rename 1

b171787

Git dont want rename capital change only

Dummy rename part 2

ae5084c

rename example using

2849f71

Use the classic millis() pattern

de24d48

yurybotov requested review from nomad605dis and AlexErAmp November 12, 2020 11:28

yurybotov added 4 commits November 12, 2020 17:56

small fix in API_ru

f2fc42d

Revert "small fix in API_ru"

06982e5

This reverts commit f2fc42d.

Add API.md

dcee547

small fix

7d9dd9e

nomad605dis reviewed Nov 12, 2020

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat ph #1

Feat ph #1

yurybotov commented Oct 22, 2020

yurybotov commented Nov 10, 2020

AlexErAmp Nov 11, 2020

yurybotov Nov 12, 2020

nomad605dis left a comment

nomad605dis Nov 12, 2020

yurybotov Nov 12, 2020

nomad605dis Nov 12, 2020

yurybotov Nov 12, 2020

nomad605dis Nov 12, 2020

yurybotov Nov 12, 2020 •

edited

Loading

nomad605dis Nov 12, 2020

yurybotov Nov 12, 2020

nomad605dis Nov 12, 2020

yurybotov Nov 12, 2020

nomad605dis Nov 12, 2020

nomad605dis Nov 12, 2020

yurybotov Nov 12, 2020

nomad605dis left a comment

nomad605dis Nov 12, 2020

nomad605dis Nov 12, 2020

nomad605dis Nov 12, 2020

nomad605dis Nov 12, 2020

nomad605dis Nov 12, 2020

nomad605dis Nov 12, 2020

nomad605dis Nov 12, 2020

nomad605dis Nov 12, 2020

nomad605dis Nov 12, 2020

nomad605dis Nov 12, 2020

nomad605dis Nov 12, 2020

nomad605dis Nov 12, 2020

nomad605dis Nov 12, 2020

nomad605dis Nov 12, 2020

-    showingTime = millis() + INTERVAL; // show result once per 3 seconds
+    constexpr uint32_t interval = 3000;
+    void setup() {
+        ...
+        showingTime = millis();
+    }
+    void loop() {
+        ...
+        if (millis() - showingTime >= interval) {
+            showingTime = millis();
+            ...
+        }
+    }

	* Product page: https://amperka.ru/product/zelo-folow-line-sensor
	* Product page: https://amperka.ru/product/troyka-ph-sensor

	TroykaPH phMeter(A4); // set used analog pin
	TroykaPH phMeter(A0); // set used analog pin

	Serial.print(phMeter.read(), 1);
	Serial.print(phMeter.read());
	Serial.println();

	Serial.print("\nCurrent pH: ");
	Serial.print("Current pH: ");

Feat ph #1

Are you sure you want to change the base?

Feat ph #1

Conversation

yurybotov commented Oct 22, 2020

yurybotov commented Nov 10, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nomad605dis left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yurybotov Nov 12, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nomad605dis left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yurybotov Nov 12, 2020 •

edited

Loading