Arduino / ESP32 library for the JSY-MK-194T single-phase two-way electric energy metering module
- Sync mode and async mode (non-blocking)
- Core, stack size and interval can be configured
- Automatically detect baud rate
- Energy reset live at runtime
- Switch bauds rate to any supported speed live at runtime
- Configurable Serial (Serial2 by default)
- Focus on speed and reactivity with a callback mechanism
- Metrics:
// tore or first clamp
volatile float current1 = 0; // A
volatile float energy1 = 0; // kWh
volatile float energyReturned1 = 0; // kWh
volatile float power1 = 0; // W
volatile float powerFactor1 = 0;
volatile float voltage1 = 0; // V
// clamp (or second clamp)
volatile float current2 = 0; // A
volatile float energy2 = 0; // kWh
volatile float energyReturned2 = 0; // kWh
volatile float power2 = 0; // W
volatile float powerFactor2 = 0;
volatile float voltage2 = 0; // V
volatile uint8_t frequency = 0; // HzHave a look at all the examples in the examples folder.
There is a getter for each metric.
Mycila::JSY jsy;
void setup() {
jsy.begin(&Serial2, 16, 17);
}
void loop() {
jsy.read();
// access values
delay(1000);
}Mycila::JSY jsy;
void setup() {
jsy.begin(&Serial2, 16, 17, true, 0);
}
void loop() {
// access values
}jsy.resetEnergy();if (jsy.isEnabled() && jsy.getBaudRate() != Mycila::JSYBaudRate::BAUD_38400) {
if (jsy.setBaudRate(Mycila::JSYBaudRate::BAUD_38400)) {
// speed changed and switched to new speed
} else {
// speed changed failed, keeping current speed
}
}JSYCallback: called when the JSY has read the data and when a change for any of the metric is detected by the JSY. This is useful to be notified exactly when required. You must check the event type
Callback Example
Reading a load for 2 second after it is turned on:
jsy.setCallback([](const Mycila::JSYEventType eventType) {
int64_t now = esp_timer_get_time();
switch (eventType) {
case Mycila::JSYEventType::EVT_READ:
Serial.printf(" - %" PRId64 " EVT_READ\n", now);
break;
case Mycila::JSYEventType::EVT_CHANGE:
Serial.printf(" - %" PRId64 " EVT_CHANGE: %f W\n", now, jsy.getPower2());
break;
default:
Serial.printf(" - %" PRId64 " ERR\n", now);
break;
}
});jsy.read() at 4800 bauds:
- 4406487 EVT_READ
- 4406577 EVT_CHANGE: 0.000000 W
- 4576361 EVT_READ
- 4576452 EVT_CHANGE: 0.567600 W
- 4746390 EVT_READ
- 4918004 EVT_READ
- 4918078 EVT_CHANGE: 238.452896 W
- 5088016 EVT_READ
- 5257985 EVT_READ
- 5258059 EVT_CHANGE: 501.204590 W
- 5428006 EVT_READ
- 5597980 EVT_READ
- 5598055 EVT_CHANGE: 509.064789 W
- 5767989 EVT_READ
- 5937958 EVT_READ
- 5938032 EVT_CHANGE: 507.976410 W
- 6107979 EVT_READ
- 6279620 EVT_READ
- 6279694 EVT_CHANGE: 507.588196 W
jsy.read() at 9600 bauds:
- 7266640 EVT_READ
- 7266727 EVT_CHANGE: 21.132200 W
- 7366557 EVT_READ
- 7474854 EVT_READ
- 7474928 EVT_CHANGE: 0.847700 W
- 7577383 EVT_READ
- 7677342 EVT_READ
- 7777330 EVT_READ
- 7877334 EVT_READ
- 7877408 EVT_CHANGE: 497.609192 W
- 7977363 EVT_READ
- 8077326 EVT_READ
- 8177318 EVT_READ
- 8177392 EVT_CHANGE: 506.894501 W
- 8277345 EVT_READ
- 8377319 EVT_READ
- 8478147 EVT_READ
- 8478222 EVT_CHANGE: 506.710205 W
- 8578164 EVT_READ
- 8678138 EVT_READ
- 8778135 EVT_READ
- 8878132 EVT_READ
- 8878207 EVT_CHANGE: 506.827393 W
- 8978150 EVT_READ
- 9078122 EVT_READ
- 9178953 EVT_READ
- 9179027 EVT_CHANGE: 506.932892 W
jsy.read() at 19200 bauds:
- 9820293 EVT_READ
- 9820383 EVT_CHANGE: 269.228302 W
- 9880195 EVT_READ
- 9940570 EVT_READ
- 10000562 EVT_READ
- 10060548 EVT_READ
- 10120538 EVT_READ
- 10120613 EVT_CHANGE: 19.392099 W
- 10180976 EVT_READ
- 10240944 EVT_READ
- 10300926 EVT_READ
- 10360912 EVT_READ
- 10421327 EVT_READ
- 10421402 EVT_CHANGE: 287.241699 W
- 10481350 EVT_READ
- 10541308 EVT_READ
- 10601290 EVT_READ
- 10661285 EVT_READ
- 10721280 EVT_READ
- 10781686 EVT_READ
- 10781769 EVT_CHANGE: 506.096008 W
- 10841700 EVT_READ
- 10901667 EVT_READ
- 10961658 EVT_READ
- 11022060 EVT_READ
- 11082050 EVT_READ
- 11082125 EVT_CHANGE: 505.992493 W
- 11142072 EVT_READ
- 11202031 EVT_READ
- 11262031 EVT_READ
- 11322425 EVT_READ
- 11382419 EVT_READ
- 11442409 EVT_READ
- 11442484 EVT_CHANGE: 505.818298 W
- 11502441 EVT_READ
- 11562390 EVT_READ
- 11622804 EVT_READ
- 11682791 EVT_READ
- 11742799 EVT_READ
- 11742874 EVT_CHANGE: 505.483002 W
- 11802804 EVT_READ
jsy.read() at 38400 bauds:
- 13017424 EVT_READ
- 13017515 EVT_CHANGE: 11.180500 W
- 13067332 EVT_READ
- 13067423 EVT_CHANGE: 0.000000 W
- 13117320 EVT_READ
- 13157496 EVT_READ
- 13207482 EVT_READ
- 13247472 EVT_READ
- 13287678 EVT_READ
- 13337675 EVT_READ
- 13377664 EVT_READ
- 13417866 EVT_READ
- 13417941 EVT_CHANGE: 320.179688 W
- 13467890 EVT_READ
- 13517859 EVT_READ
- 13557844 EVT_READ
- 13598042 EVT_READ
- 13648037 EVT_READ
- 13688036 EVT_READ
- 13728237 EVT_READ
- 13728312 EVT_CHANGE: 503.697113 W
- 13778253 EVT_READ
- 13828221 EVT_READ
- 13868215 EVT_READ
- 13908412 EVT_READ
- 13958400 EVT_READ
- 13998398 EVT_READ
- 14046098 EVT_READ
- 14046173 EVT_CHANGE: 507.100891 W
- 14088424 EVT_READ
- 14128377 EVT_READ
- 14168579 EVT_READ
- 14208568 EVT_READ
- 14248575 EVT_READ
- 14288771 EVT_READ
- 14328769 EVT_READ
- 14376462 EVT_READ
- 14376537 EVT_CHANGE: 507.294708 W
- 14418996 EVT_READ
- 14468947 EVT_READ
- 14508941 EVT_READ
- 14548930 EVT_READ
- 14589151 EVT_READ
- 14629129 EVT_READ
- 14669129 EVT_READ
- 14709325 EVT_READ
- 14709400 EVT_CHANGE: 507.153198 W
- 14759359 EVT_READ
- 14799311 EVT_READ
- 14839513 EVT_READ
- 14889501 EVT_READ
- 14929499 EVT_READ
- 14969706 EVT_READ
Here are below some test results for the JSY at different baud rates for 50 consecutive reads on a nominal load of about 650W, controlled with a random SSR relay (0-100%).
You can run the PerfTests from the examples.
PerfTest1
jsy.read() at 4800 bauds:
- Errors: 0
- Average read time: 170583 us
- Min read time: 168330 us
- Max read time: 178322 us
jsy.read() at 9600 bauds:
- Errors: 0
- Average read time: 100525 us
- Min read time: 99897 us
- Max read time: 108333 us
jsy.read() at 19200 bauds:
- Errors: 0
- Average read time: 60078 us
- Min read time: 59568 us
- Max read time: 60413 us
jsy.read() at 38400 bauds:
- Errors: 0
- Average read time: 41248 us
- Min read time: 39894 us
- Max read time: 49936 us
PerfTest2
jsy.read() at 4800 bauds:
- ROUND: 1
* Load Detection time: 169670 us (1 reads)
* Ramp up time: 347890 us (2 reads)
* Ramp down time: 1363108 us (8 reads)
- ROUND: 2
* Load Detection time: 679860 us (4 reads)
* Ramp up time: 1191511 us (7 reads)
* Ramp down time: 1531476 us (9 reads)
- ROUND: 3
* Load Detection time: 679867 us (4 reads)
* Ramp up time: 1198192 us (7 reads)
* Ramp down time: 1363164 us (8 reads)
- ROUND: 4
* Load Detection time: 681522 us (4 reads)
* Ramp up time: 1191498 us (7 reads)
* Ramp down time: 1531493 us (9 reads)
jsy.read() at 9600 bauds:
- ROUND: 1
* Load Detection time: 299799 us (3 reads)
* Ramp up time: 1100600 us (11 reads)
* Ramp down time: 1501484 us (15 reads)
- ROUND: 2
* Load Detection time: 700694 us (7 reads)
* Ramp up time: 1101510 us (11 reads)
* Ramp down time: 1501474 us (15 reads)
- ROUND: 3
* Load Detection time: 400709 us (4 reads)
* Ramp up time: 800693 us (8 reads)
* Ramp down time: 1201502 us (12 reads)
- ROUND: 4
* Load Detection time: 700710 us (7 reads)
* Ramp up time: 800693 us (8 reads)
* Ramp down time: 1200678 us (12 reads)
jsy.read() at 19200 bauds:
- ROUND: 1
* Load Detection time: 362264 us (6 reads)
* Ramp up time: 1082982 us (18 reads)
* Ramp down time: 1261343 us (21 reads)
- ROUND: 2
* Load Detection time: 300247 us (5 reads)
* Ramp up time: 1020957 us (17 reads)
* Ramp down time: 1261351 us (21 reads)
- ROUND: 3
* Load Detection time: 360253 us (6 reads)
* Ramp up time: 1081379 us (18 reads)
* Ramp down time: 1260926 us (21 reads)
- ROUND: 4
* Load Detection time: 300273 us (5 reads)
* Ramp up time: 1020982 us (17 reads)
* Ramp down time: 1261351 us (21 reads)
jsy.read() at 38400 bauds:
- ROUND: 1
* Load Detection time: 468076 us (11 reads)
* Ramp up time: 840729 us (20 reads)
* Ramp down time: 1291332 us (32 reads)
- ROUND: 2
* Load Detection time: 330244 us (8 reads)
* Ramp up time: 1020971 us (25 reads)
* Ramp down time: 1281353 us (32 reads)
- ROUND: 3
* Load Detection time: 330047 us (8 reads)
* Ramp up time: 1030773 us (25 reads)
* Ramp down time: 1301323 us (32 reads)
- ROUND: 4
* Load Detection time: 330047 us (8 reads)
* Ramp up time: 1010776 us (25 reads)
* Ramp down time: 1281343 us (32 reads)
The "Load Detection time" is the time it takes for the JSY to see a load > 0 just after the relay was closed on a constant resistive load.
The "Ramp up time" is the time it takes for the JSY to stabilize (with a maximum delta of 1% from last measurement) and see an expected load value.
The "Ramp down time" is the time it takes for the JSY to return to 0W after the relay was opened.
What these results mean ?
-
Speed up the JSY allows to read data faster and consequently block less the program if not using any dedicated task to read the JSY
-
It takes more than 300 ms for the JSY to report a change of a load appearing on the wire. So if you read the JSY each 300 ms, it can take up to 600 ms to see a change if you miss it. Reading the JSY more frequently (in a async loop) and faster will allow a change to be seen as fast as possible, but it will still take at least 300 ms for the change to be seen. The best reactivity is achieved when reading the JSY in a loop at 38400 bauds, when the detection time is around 330 ms and quite consistent.
-
It takes more than 1 second for the JSY to report a load value which is stable and according to what we expect. This duration contains the duration for the load to reach its nominal power, plus the duration it takes for the JSY to stabilize its measurements (I think the JSY is using some kind of filtering or averaging).
-
Reading the JSY too frequently will lead to the same results, so an improvement could be to have the JSY read in a dedicated task asynchronously and use the callback mechanism to be called as soon as the JSY sees a change
- JSY-MK-194T 1.pdf (version 1)
- JSY-MK-194T 2.pdf (version 2)
- JSY-MK-194T 3.pdf (version 3)
- JSY-MK-194T.exe (Utility to configure the JSY with a USB-TTL adapter)
- ModbusMechanic (can connect and configure JSY with a USB-TTL adapter)