logo elektroda
logo elektroda
X
logo elektroda

Extending the time sources on OpenBeken devices

max4elektroda 1050 8
ADVERTISEMENT
📢 Listen (AI):
  • GPS module with ceramic antenna and 4-pin female connector
    Recently time code from OBK was changed to allow for more time sources (beside the well known NTP).

    The possibly simplest method is setting the OpenBeken time to the time of the device you are using to access the GUI (this is allready in OBK code, just not enabled):

    Setting device time to browser time

    If you define "ENABLE_TIME_PMNTP" in obk_config.h your GUI will show an additional button "Set clock to PC time", which will set the time to the time of your PC/Tablet...:

    Control panel with buttons Config, Restart, Launch Web Application, About and Set clock to PC time




    This is done once, and the accuracy depends on your device: My LN882H seems quite good, in half a year the drift was only about 5 minutes - if you set it regulary, you can keep it even better.

    But of course there are more things to present:

    Using a DS3231 RTC

    RTC module with DS3231 chip showing pin labels and components

    Also allready present is a driver for the DS3231 RTC - a cheap possibility to add a battery powered RTC chip which can set the time e.g. on startup.
    It's enabled in obk_config.h with "#define ENABLE_DRIVER_DS3231 1"
    Useful in case the device has no access to another time source, e.g. when there's no internet and hence no NTP possible.
    An important hint if you have one of those cheap battery powered devices like this one: The circuit is designed for a rechargeable battery - if used with e common CR2032 this might blow up your cell (or maybe even worse).
    You can easily test if "VCC" is connected to the battery's "+" over a 200 ohm resistor and a diode. If so, I suggest to simply remove the resistor to protect your battery:
    Close-up of a PCB with SCL, SDA and VCC labels, a red diode, and soldered joints visible.
    If your hardware is clear, you start the driver with

    startdriver DS3231 <SCL-pin> <SDA-pin> <optional arg>


    the optional argument will define if and when the openbeken time is set to the RTC time:
    "1" - this will set the device time to RTC time once on startup
    "2" - the device time is regulary (every minute) set to the RTC time, so RTC is "master clock" for the device.

    To set the RTC you can use the two commands
    DS3231_SetTime <hours> <minutes> <seconds> <day> <month> <year> - (e.g. DS3231_SetTime 19 50 01 13 8 25)
    DS3231_SetEpoch <epoch since 1970> - (e.g. DS3231_SetEpoch 3269879540)

    If you are using a Linux PC you might "set" the RTC via
    wget -q "http://<your.device.IP.address>/cmd_tool?cmd=DS3231_SetEpoch+$(date -u +%s)"

    Here's a picture of an ESP32 with DS3231 on pins 25 (SDA) and 26 (SCL).
    ESP32 board with connected sensor module on breadboard using colored wires

    So I am starting the driver with
    startdriver DS3231 26 25 1
    

    to set devices clock to RTC time once on startup of driver.


    If you don't have (or don't want) your device to get the time via internet and NTP I made two pull requests for additional time sources: GPS and DCF77 (a German longwave time signal radio station).

    Using GPS as time source - NEO-6M driver

    This is actually present in PR#1890

    For the devices with a usable UART, you can use my NEO-6M driver. It will decode the NMEA statements from the device and allow you to set the devices time and even latitude/longitude in case you are using "sunrise/sunset" calculations.
    The modules are quite cheap (~2.5 to 3 € on ali) an you need to connect the NEO-6M RX and TX to the devices TX and RX.
    GPS module with ceramic antenna and 4-pin female connector

    Here an example with the module connected to BK7238 module (needs "flag 26" for me, so NEO6M TX is connected to P1 and NEOs RX to P0).
    GPS module connected to ESP8266 microcontroller on a breadboard
    You have the following arguments to
    "startdriver NEO6M"


    "<baudrate>" will use the integer as baud rate - this requires NEO6M was set to this baudrate permanently before. It will not send any command to NEO6M!
    "setclock" will set the obk time to GPS time if NEO6M is "locked"
    "setlatlong" will set the obk latitude/longitude to GPS values if NEO6M is "locked" (and "ENABLE_TIME_SUNSET_SUNRISE" is defined)

    Usually the GPS module will send a lot of NMEA messages every second - this would need a lot of buffer for the "parser".
    So on startup the driver will send the command to disable all messages except RMC (we will only parse "$GPRMC" lines).
    If you have the possibility to set the NEOM6 permanently to only this output, you would only need the RX on the obk side.

    You might read and set the module via "u-Center" software available at "https://www.u-blox.com" - or use the recenty added "savecfg" argument to "startdriver".
    Not tested too much, but works o.k. here ...

    Device status panel OpenBK7231N with GPS data and WiFi signal strength shown

    As my desk is not directly next to a window, reception sometimes is bad. So I bought a pigtail and an antenna for a vehicle with an 2m cable.
    GPS antenna set with black cable, SMA connector, and mounting end fitting
    I didn't measure, but I'd say reception is not as good as if I lay the original antenna there - but it's o.k. to get a GPS signal even 1.5 meters away from the window.

    If you are using a smart switch with live wires, remember that the ground (GND) is usually not isolated from the live wires! So you will need complete insulation to prevent electric shock.

    Using a DCF77 receiver

    This is actually present in PR#1911

    For small money you will get a small board with an ferrite antenna like this one:
    DCF77 time signal receiver module with ferrite rod antenna and PCB

    It will decode a radio signal broadcasting the actual time in "bits" represented by signal changes. Every second there is a 100ms ("0") or 200ms "1" change which is decoded as high/low on the modules output.

    Since it's often used in battery powered devices, you need to enable reception by pulling the "PON" pin to GND.

    The driver will decode the signal by collecting the bits over one minute and then calculate date, time and DST (summer-/winter-time).
    Reception is not too reliable, even with the parity bit it sometimes receives a wrong time.
    You can therefore test, if the next signal is 60 seconds after the previous to be quite sure, reception is fine.

    The decoding is done via interrupts and tested on LN882H, Beken, BL602 and ESP platforms for now.
    Here's some debug output from the reception and decoding of the signal:
    Screenshot showing DCF77 time signal decoding in OpenBeken device logs.

    Starting with
    startdriver DCF77

    optional arguments are
    "fall" per default, a rising edge will mark the "bits", if you need a falling edge (e.g. if using a opto-isolator), use this argument
    "httpstat" add some details from driver on main page
    OpenBK7231N control panel with DCF77 time source and local clock status

    As stated before, smart switches IO pins are usually live, so I also tried if this works trough an opto-isolator: It does (but inverts the signal in my very simple realization):
    ESP32 and DS3231 modules wired on a breadboard with USB power supply

    This shows my test with a BK7231N switch (here powered by a PoE power supply with 48V) and the receiver input on the "switch" (since opto coupler inverts the signal, I used it with "fall" argument). I'm using a common PC-817 and a 220 ohm resistor for 3.3V for DCF77 device.

    Cool? Ranking DIY
    About Author
    max4elektroda
    Level 23  
    Offline 
    max4elektroda wrote 665 posts with rating 161, helped 38 times. Been with us since 2024 year.
  • ADVERTISEMENT
  • #2 21786490
    p.kaczmarek2
    Moderator Smart Home
    Very nice, I didn't even realize there are so many time sources around! Did you use my new HAL interrupts API for DCF77 on LN882H, Beken, BL602 and ESP? How crucial are timings for DCF77, were there any timing-related issues when decoding the signal?
    Helpful post? Buy me a coffee.
  • ADVERTISEMENT
  • #3 21786722
    insmod
    Level 30  
    HAL IRQ is not used.
    But, do you think you can adapt BK and BL change interrupts to HAL?
    Plus, LN882H, Realteks after B, ECR, and XRs can use both edge irq oob.

    I doubt this driver would be used very often, so i think IOR should be removed.
  • ADVERTISEMENT
  • #4 21786758
    p.kaczmarek2
    Moderator Smart Home
    Well, if it's not using IRQ HAL, then @max4elektroda probably should integrate with our HAL first. It will be way cleaner that way.

    I don't worry much about new IOR role. In the past, I didn't want to add new IOR roles because on the pins config page they were sent as separate combobox for each pin, so the page size grew fast, but I think they are now sent once, right? If the pins page sending is solved, then there isn't really much cost to adding IOR role except the single value in enumeration (which I can assume uses byte, so goes up to 255), and a string name entry in table...

    Or is there some hidden IOR cost that I forget about?
    Helpful post? Buy me a coffee.
  • ADVERTISEMENT
  • #5 21786764
    max4elektroda
    Level 23  
    Yes, this driver was made before and while HAL_IRQ was created, I will try to change it.

    For now added missing "CHANGE" to W600/W800 (tested), LN882H (testing atm, but it'crashing from time to time, it seems IRQ handler needs to be shortened...) and ESP (untested).
    All were only using rise and fall.

    This is the W800 example:

    diff --git a/src/hal/w800/hal_pins_w800.c b/src/hal/w800/hal_pins_w800.c
    index 9810794d..d294e2b6 100644
    --- a/src/hal/w800/hal_pins_w800.c
    +++ b/src/hal/w800/hal_pins_w800.c
    @@ -271,8 +271,10 @@ void HAL_AttachInterrupt(int pinIndex, OBKInterruptType mode, OBKInterruptHandle
            if (mode == INTERRUPT_RISING) {
                    w_mode = WM_GPIO_IRQ_TRIG_RISING_EDGE;
            }
    -       else {
    +       else if (mode == INTERRUPT_FALLING) {
                    w_mode = WM_GPIO_IRQ_TRIG_FALLING_EDGE;
    +       } else {
    +               w_mode = WM_GPIO_IRQ_TRIG_DOUBLE_EDGE;
            }
            tls_gpio_irq_enable(w600Pin, w_mode);
     }
    


    Maybe I simply switch to the "rising/falling" node for all platforms.
    Regarding an own "IOR" you are right, will change this to an argument

    Actual WIP code works on W800 ("INTERRUPT_CHANGE") and BL602 ("INTERRUPT_RISING"/"INTERRUPT_FALLING") and fails on LN882H (tried both, now I need to find out how to shorten IRQ handler)

    insmod wrote:
    But, do you think you can adapt BK and BL change interrupts to HAL?

    Never looked to deep in the interrupt code, maybe after I got this DCF77 code working with the new API.
  • #6 21786839
    p.kaczmarek2
    Moderator Smart Home
    Beken has no native change interrupt I think, so you need to set it up again to opposite edge with each event.
    Helpful post? Buy me a coffee.
  • #7 21786964
    max4elektroda
    Level 23  
    Switched to new IRQ API and added "CHANGE" for the platforms I knew about and can test:
    W800, LN882H and ESP - tested with ESP8266.
    DCF driver works for these (LN882H tested with both "flavors": "CHANGE" and "RISING/FALLING")

    Tested on BL602 as a platform w/o "CHANGE" interrupt.

    Code is really much nicer now.
    There's still some cleanup necessary to remove some only commented out code from the old approach of interrupt handling...

    Moved code not necessarily done in ISR to a new QuickTick function (processing only once a second might fail if we try to process the date while we are in the 100/200ms of one signal).

    Didn't change IOR role but must finish for today.
  • #8 21787101
    p.kaczmarek2
    Moderator Smart Home
    Nice, HAL updates are necessary, it's good they turned out to be done today already.

    IOR entry is your choice, at the moment I don't think it has much impact on the main build size.
    Helpful post? Buy me a coffee.
  • #9 21787289
    dktr
    Level 26  
    Cool, at one time I tested on an esp8266 + gps neo6p and with the PPS output connected and you can make a pretty reasonable NTP time server out of it.
📢 Listen (AI):

Topic summary

The OpenBeken (OBK) firmware has been updated to support multiple time sources beyond the traditional NTP synchronization. One simple method enabled by defining "ENABLE_TIME_PMNTP" in obk_config.h allows setting the device clock to the time of the browser accessing the GUI via a "Set clock to PC time" button. This method relies on the accuracy of the client device's clock and can maintain reasonable time precision with regular updates, as demonstrated by the LN882H module with minimal drift over six months. Additionally, OBK supports integration with a DS3231 Real-Time Clock (RTC) module, providing a battery-backed hardware time source for improved timekeeping stability independent of network connectivity.
Summary generated by the language model.
ADVERTISEMENT