This live screen grab is from one of my HamClocks. It updates automatically every minute after making a random change.

Ham Clock

This page refers to my QST article in the October 2017 issue. All updates will be posted here.


News highlights: See the complete version history in the Download tab and details in the User Guide.
  • live web access -- see FAQ or just browse to http://<your-clock-ip>/live.html
  • DX Cluster paths can be drawn on the map, and support for Spider filters.
  • flrig and hamlib supported for rig and rotator control.
  • Now manufactured by Veritium Research rebranded as HFClock. Available direct or in Europe from Lutz Electronics.

73, Elwood Downey, WBØOEW

Original QST Article proof

Corrections:

Download current stable HamClock release source code as zip or tgz.

Revision history:

Version 2.78: 2022-05-22 Version 2.77: 2022-04-17 Version 2.76: 2022-03-15 Version 2.75: 2022-03-12 Version 2.74: 2022-02-12 Version 2.73: 2022-01-15 Version 2.72: 2021-12-18 Version 2.71: 2021-12-11 Version 2.70: 2021-11-26 Version 2.69: 2021-10-16 Version 2.68: 2021-09-11 Version 2.67: 2021-09-06 Version 2.66: 2021-08-08 Version 2.65: 2021-07-04 Version 2.64: 2021-07-03 Version 2.63: 2021-06-18 Version 2.62: 2021-05-23 Version 2.61: 2021-04-10 Version 2.60: 2021-03-21 Version 2.59: 2021-02-27 Version 2.58: 2021-02-18 Version 2.57: 2021-01-24 Version 2.56: 2021-01-09 Version 2.55: 2020-12-13 Version 2.54: 2020-12-05 Version 2.53: 2020-10-28 Version 2.52: 2020-10-10 Version 2.51: 2020-08-08 Version 2.50: 2020-07-26 Version 2.49: 2020-07-10 Version 2.48: 2020-07-03 Version 2.47: 2020-06-19 Version 2.46: 2020-05-29 Version 2.45: 2020-05-13 Version 2.44: 2020-05-07 Version 2.43: 2020-04-16 Version 2.42: 2020-04-02 Version 2.41: 2020-03-04 Version 2.40: 2020-01-19 Version 2.39: 2020-01-18 Version 2.38: 2020-01-01 Version 2.37: 2019-12-27 Version 2.36: 2019-12-21 Version 2.35: 2019-12-15 Version 2.34: 2019-12-02 Version 2.33: 2019-11-28 Version 2.32: 2019-11-26 Version 2.31: 2019-11-11 Version 2.30: 2019-10-25 Version 2.29: 2019-10-11 Version 2.28: 2019-10-11 Version 2.27: 2019-10-10 Version 2.26: 2019-10-09 Version 2.25: 2019-10-07 Version 2.24: 2019-10-02 Version 2.23: 2019-09-28 Version 2.22: 2019-09-23 Version 2.21: 2019-09-20 Version 2.20: 2019-09-14 Version 2.19: 2019-09-10 Version 2.18: 2019-08-18 Version 2.17: 2019-08-16 Version 2.16: 2019-08-10 Version 2.15: 2019-08-07 Version 2.14: 2019-08-05 Version 2.13: 2019-08-05 Version 2.12: 2019-08-05 Version 2.11: 2019-08-04 Version 2.10: 2019-08-03 Version 2.09: 2019-07-27 Version 2.08: 2019-07-19 Version 2.07: 2019-07-14 Version 2.06: 2019-07-11 Version 2.05: 2019-07-10 Version 2.04: 2019-07-06 Version 2.03: 2019-07-03 Version 2.02: 2019-06-20 Version 2.01: 2019-06-10 Version 2.00: 2019-05-27 Version 1.94: 2019-05-13 Version 1.93: 2019-05-10 Version 1.92: 2019-05-09 Version 1.91: 2019-04-24 Version 1.90: 2019-03-31 Version 1.89: 2019-03-15 Version 1.88: 2019-01-20 Version 1.87: 2018-12-25 Version 1.86: 2018-12-23 Version 1.85: 2018-12-17 Version 1.84: 2018-12-11 Version 1.83: 2018-12-10 Version 1.82: 2018-12-03 Version 1.81: 2018-12-01 Version 1.80: 2018-11-24 Version 1.79: 2018-11-23 Version 1.78: 2018-11-21 Version 1.77: 2018-11-04 Version 1.76: 2018-10-08 Version 1.75: 2018-10-05 Version 1.74: 2018-09-29 Version 1.73: 2018-09-28 Version 1.72: 2018-09-25 Version 1.71: 2018-09-23 Version 1.70: 2018-09-22 Version 1.69: 2018-09-19 Version 1.68: 2018-09-17 Version 1.67: 2018-09-15 Version 1.66: 2018-09-12 Version 1.65: 2018-09-09 Version 1.64: 2018-09-06 Version 1.63: 2018-09-04 Version 1.62: 2018-09-02 Version 1.61: 2018-09-01 Version 1.60: 2018-08-25 Version 1.59: 2018-08-22 Version 1.58: 2018-08-19 Version 1.57: 2018-08-19 Version 1.56: 2018-08-19 Version 1.55: 2018-08-16 Version 1.54: 2018-06-30 Version 1.53: 2018-06-19 Version 1.52: 2018-06-03 Version 1.51: 2018-06-01 Version 1.50: 2018-05-29 Version 1.49: 2018-05-13 Version 1.48: 2018-05-12 Version 1.47: 2018-05-05 Version 1.46: 2018-05-01 Version 1.45: 2018-04-29 Version 1.44: 2018-04-27 Version 1.43: 2018-04-20 Version 1.42: 2018-04-10 Version 1.41: 2018-03-25 Version 1.40: 2018-03-18 Version 1.39: 2018-02-17 Version 1.38: 2018-02-10 Version 1.37: 2018-02-04 Version 1.36: 2018-01-24 Version 1.35: 2018-01-19 Version 1.34: 2018-01-10 Version 1.33: 2017-12-30 Version 1.32: 2017-12-08 Version 1.31: 2017-11-26 Version 1.30: 2017-11-25 Version 1.29: 2017-11-17 Version 1.28: 2017-11-10 Version 1.27: 2017-10-19 Version 1.26: 2017-10-05 Version 1.25: 2017-10-04 Version 1.24: 2017-10-02 Version 1.23: 2017-09-30 Version 1.22: 2017-09-30 Version 1.21: 2017-09-23 Version 1.20: 2017-09-21 Version 1.19: 2017-09-20 Version 1.18: 2017-09-19 Version 1.17: 2017-09-17 Version 1.16: 2017-08-20

How do I build the ESP8266 software?

See the ESP8266 Notes tab.

How do I build the Desktop software?

See the Desktop tab.

How do I uninstall HamClock?

Assuming you only ever installed HamClock according to my instructions in the Desktop tab, you can remove all traces by typing the following two commands in a terminal or ssh session:

    sudo sh -c 'rm -fr ~/.hamclock ~/ESPHamClock* /usr/local/bin/hamclock*'
    rm -fr ~/.hamclock ~/ESPHamClock*
    

I'm new to Raspberry Pi -- how do I get started?

  1. If you are absolutely completely new, start at raspberrypi.org.
  2. If you don't have a Pi yet, I would start with a model 4b with 2 GB RAM. For a display you can either use a small touch screen for a stand-alone kiosk style system or get a USB mouse and keyboard and a nice LCD display with micro HDMI connector for a "PC" style system. Either way you'll also need a USB-C charger.

    All these are available at many many places around the web but, again, raspberrypi.org lists their preferred options with vendor recommendations here.

  3. Buy a microSD card such as this one
  4. Insert the microSD card into your desktop computer. If your computer does not have uSD port, you can try a USB adaptor such as this one.
  5. Download and install the Raspberry Pi Imager
  6. Start the program and burn your microSD card with RPi operating system as follows:
    1. click Choose OS
    2. select the first choice on top
    3. click Choose Storage
    4. select the microSD you just inserted
    5. click Write
    6. wait for it to complete writing and verifying
    7. remove the microSD card when it says it is finished
  7. Insert the microSD card into your RPi
  8. Connect a keyboard, mouse, ethernet and HDMI monitor to your RPi
  9. Connect power to the RPi
  10. After a minute or so you will see the Desktop
  11. Work through the setup menus
  12. Start a browser by clicking the red raspberry in the upper left corner then Internet ⇒ Chromium
  13. Go to my project web page at https://clearskyinstitute.com/ham/HamClock
  14. Start a terminal by clicking the red raspberry again then Accessories ⇒ Terminal
  15. Follow the instructions on my Desktop tab
  16. Read the User Guide to get the most from HamClock

What can I do if a self-update reports FAIL with a message about SSL certificate?

This error means your system is using a version of openssl (used by curl) that is older than 1.1.1. This occurs because a prominent high level SSL certificate expired on Sept 30 2021 and openssl was updated to use the replacement certificate. You can find your version by opening a terminal command line and typing this command:

openssl version

To update openssl on an RPi you can try

sudo apt upgrade openssl

To update openssl on macOS using macports you can try

sudo port upgrade openssl

(be sure /opt/local/bin is before /usr/bin in your PATH)

After the update, repeat the openssl command and you should see version 1.1.1 or larger. If so, repeat your HamClock version update and it should work.

I'm getting a big black screen on my RPi with a cryptic message, what do I do?

It depends on the message.

  • If it says there is a permission error related to a certain file, look at the permissions of the file, and each directory leading up to it, and make changes as necessary so the effective user id of hamclock has sufficient authority to access the file.

    Or just start all over. See the separate FAQ about removing HamClock. Then go over to the Desktop tab and follow the instructions.

  • The message is sh: 0: illegal option -p ?

    This happened in Version 2.58 on RPi if you are running an os version earilier than Buster. It is now fixed so the easiest solution is to remove your current ESPHamClock (see separate FAQ) and install fresh using the instructions in the Desktop tab.

    And while you're at it, if you are using the fb0 version, change to the GUI version, again see instructions and the other FAQ here about fb0 for details.

  • Something else?

    Copy it down exactly and email it to me.

Can HamClock run on Windows?

No, you can't run it natively on Windows but you can use it if it is already running somewhere else on your network by using any desktop browser. See the FAQ answer about the hamclock web interface for details.

For another approach, see the User Contrib pane for a suggestion on how to use WSL.

Can HamClock run on iPhone or iPad or Android?

No, you can't run it natively on an iPad but you can use it if it is already running somewhere else on your network by using your iPad's browser. See the FAQ answer about the hamclock web interface for details.

How does HamClock compare to Geochron 4k?

I do not have a Geochron 4K but from its literature I can think of the following functions related to ham radio that HamClock offers but Geochron does not:

  1. VOACAP propagation predictions for any HF band or path at several power levels
  2. trend plots and predictions for solar flux, solar wind, sunspot, XRay, Kp index and DRAP
  3. short and long path antenna beam heading and distance to any DX location
  4. display future satellite rise/set times and next overhead pass (not just global track)
  5. hamlib and flrig rig and rotator control for chasing DX spots
  6. display DE time in digital, analog or calendar formats
  7. azimuthal world maps centered on any location
  8. local weather, time, grid square, prefix and sun rise/set times at any DX location
  9. live display of DX Cluster, WSJT-X and JTDX FT8 contacts
  10. live solar images from Solar Dynamics Observatory and STEREO-A
  11. live quantitative Lunar data and EME planning tool
  12. live NCDXF beacon location, time and frequency schedule
  13. live RSS feeds from popular ham web sites
  14. live D layer absorption map
  15. live auroral map
  16. stopwatch and station ID count-down timer with optional color LED and switch control
  17. adjust time forward or back to explore Moon, gray line, satellite orbits etc
  18. Elecraft KX3 transceiver frequency control from DX Cluster spot
  19. 2 BME280 sensors for temperature, pressure and humidity real-time and 25 hour trend plots
  20. photosensor to adjust display brightness with changes in room lighting
  21. "On The Air" indicator controlled by GPIO pin from radio
  22. remote control functions from any browser or curl command line
  23. can become just a simple old fashioned time-and-temperature clock

Conversely, Geochron can do things HamClock can not. These items are certainly interesting but to me they do not seem specifically useful to the typical amateur radio operator:

  1. air and sea traffic
  2. pollution, population and pandemic maps

I have nothing against Geochron. If I have misrepresented Geochron in any way, please tell me how and I will correct immediately.

How does the DX Cluster feature work?

  1. In the Setup page, tap the Cluster? button then set the internet host name and port for your desired DX Spider node. A good list is here. Be sure to choose a Spider node because AR and CC clusters are not supported for now. You may also enter a login different from your call, such as an SSID like WB0OEW-1. You can control whether spots are labeled on the map as complete call signs or just the prefix and whether the full path is drawn (only the DX side is labeled). Turn off the Cluster? button if you don't want to use a cluster at all.
  2. You can also enter up to four arbitrary spider commands. A nice filter primer is here. Those commands that are set On will be sent one time when HamClock logs into the node. HamClock will store all the commands for you, whether they or set On or Off.
  3. It is important to understand that spider commands are saved on the node and remain in effect even if you log out and log back in. It is not enough to just not send them to get the opposite effect. For example, suppose you want to reject all spots of US amateurs, you could enter this command and set it On:
        rej/spot 0 call_dxcc 226
        
    Because it is marked On HamClock will send this command when it logs in. Now suppose you restart HamClock and just turn this command Off. This tells HamClock to not send this command when it logs in. That's fine, but since spider remembers your settings across logins, the filter will still remain in effect! To turn off this filter, you need another command to explicitly clear it, such as
        clear/spot 0
        
    Thus, it's a good idea to create pairs of spider commands, one to engage and one to cancel each filter type.
  4. Once HamClock is up and running, select the DX Cluster pane in either of the two right panes. The name of the host will be shown in yellow while a connection attempt is in progress, then it will turn green when the connection is established. If the connection fails, it will show an error in red.
  5. Once connected, just leave it run, new spots will be listed, scrolling down when full. Tap on a spot to set HamClock's DX to that location. The tap can also set the frequency of your radio, see the User Guide for details.
  6. HamClock stores several more spots than those listed; use the Up and Down arrows to scroll backwards and forwards through time. HamClock always adds new spots to the end of the list, but if you have scrolled Up HamClock will not automatically scroll down to show them. To insure you will see new spots immediately, just make sure the Down arrow is not drawn.
  7. Beware: HamClock stays logged into the cluster node with your call sign as long as the DX Cluster pane is visible. So do not use this feature if you want to use the unassisted category in a contest -- some judges do check!
  8. The same mechanism can communicate with WSJT-X or JTDX. Instead of showing cluster spots, it shows each FT8 station you attempt to work and also immediately defines HamClock's DX with its location. Details for doing this are in the User Guide.

Can I make different sizes other than those in the Makefile?

No, it's not that simple. Each size requires its own custom fonts, graphics symbols, maps and images in order to take proper advantage of the different resolutions. Otherwise, these would be very pixelated if they were just multiples of the base images. Plus, if the aspect ratio changes, the layout would need to be rebalanced. This is why all sizes are multiples of 2 of the base size in order to maintain the same layout proportions.

What is xrandr, or How do I get rid of the full-screen black border?

Even though full screen mode uses the entire screen, HamClock still only uses the pixels specified in the make command size, filling the remaining space with black. With the GUI configuration (not fb0) you can try a command line program called xrandr to expand HamClock to fill the screen by changing the effective display resolution to match HamClock.

Xrandr works by changing how the X server maps pixels to the display hardware. It's easy to try and undo if you decide you don't like it.

For example, my display is 1920 x 1080. The closest I can build HamClock is 1600 x 960. If I run this size with the Full screen option in setup set to Yes, HamClock will still be that size but will fill the surrounding gaps with black. With xrandr one can expand HamClock to fill the screen and eliminate those gaps.

To try it on a Pi, log in with ssh so we aren't trying to adjust the same screen we are using for commands. Run the following command while HamClock is running in its full screen mode:

        xrandr --output HDMI-1 --scale-from 1600x960 --display :0
        

(it's better to think of that argument as meaning scale-to)

That's it, the effect should be immediate but ...

  • If xrandr gives an error about failing to get size of gamma, check the GL driver is installed with sudo raspi-config as:

    Advanced Options ⇒ GL driver ⇒ OpenGL with fake KMS ⇒ Ok ⇒ Ok ⇒ Finish ⇒ Reboot now

  • You might also get better cursor performance if you increase the GPU memory, again using raspi-config as follows:

    Performance Options ⇒ GPU Memory ⇒ 256 ⇒ Ok ⇒ Finish ⇒ Reboot now

  • If xrandr gives an error about bad parameter match, try changing scale-from a little.
  • If you want to go back to normal run
        xrandr --output HDMI-1 --scale-from 1920x1080 --display :0
        

Modify these values to accommodate your particular combination of HamClock and display sizes as needed.

The display aspect change is accomplished using non-square pixels within the X server. This doesn't usually matter much but if you often run analog Big Clock you may notice it is no longer circular. Adjust the xrandr dimensions to find a compromise between filling the screen and making the circle look nice.

The xrandr changes do not survive logging out or rebooting. If you want the resolution change to happen automatically every time you start your GUI, put the xrandr command in the file ~/.xsessionrc. Combine this with using autostart (see Desktop instructions) and you can arrange for HamClock to start automatically at truly full screen size directly from RPi power up.

One final point for the RPi. If you still have a small black border, you may have video underscan compensation turned on. To turn it off run sudo raspi-config then work through

Display Options ⇒ Underscan ⇒ enable? ⇒ No ⇒ Ok ⇒ Finish

and run sudo reboot if it doesn't ask you to reboot on the way out.

xrandr works on macOS too with XQuartz but it only allows choosing from a fixed set of sizes. So you can still reduce the border but you may not be able to eliminate it altogether. The general idea is to use the following procedure, again adjust sizes to fit your situation:

  1. Run xrandr with no arguments for a list of available sizes; pick one at or slightly larger than your hamclock.
  2. Start HamClock and enter Setup.
  3. Go to Page 2, click Full Screen to Yes; now just leave it there for the moment and go to the next step.
  4. In another terminal run xrandr --size 1600x1200. You'll see the hamclock size jump.
  5. Now back in HamClock, click Done and HamClock should now occupy almost the entire screen.
  6. To get your screen back to normal, hold HamClock's padlock for 3 seconds, then choose exit.
  7. If you get really stuck in full-screen mode, type Option-Command-A to force XQuartz back to normal.

Can you bring back the old VOACAP pane? I liked it much better.

In a word, no. I have two reasons.

One is the previous version provided precision far beyond what is real. The VOACAP model is based on monthly averages, so several tens of percentage point changes can easily occur due to solar flares, geomagnetic disturbances and other effects that happen very rapidly. So although the model does generate percentage values, they don't really have as much meaning as the precision implies. I think of the VOACAP model as similar to climate. As the saying goes "climate is what you expect, weather is what you get".

The second reason is I think seeing the daily trends adds greatly to the value of the display. For example, at a glance you can tell whether conditions will improve or get worse in the next few hours, or quickly pick a time of day that offers the best chances to contact a given location. These trends and planning capabilities were not possible when only the present hour values were shown.

Having said this, I will allow that it was nice to see just the current conditions at a glance. This is why I added a small marker below the new graph to show the current time. This way, you can just scan your eye up that column to see basically the same information as presented previously, with precision that represents reality just as well. Granted they are not numbers, but the color choices remain the same as before: red < 33%, yellow < 66% and green above 66%, with one change that I now make < 10% black.

Give it more time and perhaps you will come to like the new graph as much as I do.

Does the HamClock have a web interface?

Yes. Use a browser to load the page live.html on port 8080 from the host running hamclock. For example, if the IP of the computer running HamClock is 192.168.7.101, then enter this URL to run it from your browser:

        http://192.168.7.101:8080/live.html
        

Some notes:

  • The browser display will be the same size as you built hamclock (although see below for resizing ideas).
  • Larger sizes will require higher network bandwidth.
  • Keyboard input works if you first click on the HamClock image to give it focus.
  • Use meta-click (⌘-click on macOS) for long-click (for example to restart)
  • Multiple simultaneous browser connections are supported if they each come from a different host. Multiple connections from the same host will appear at first to work, but you will find they soon become pixelated and out of sync with the real clock display.
  • To reset a browser session for any reason, refresh the page.
  • Tested fine with Chrome 101 and Safari 15.5, Firefox 100 is a little flaky.
  • Screen blanking and Cities are not supported.
  • Not available from an ESP HamClock.

Why would you use this?

  • It's a convenient way to configure a HamClock that runs on a host to which you normally do not have a keyboard and mouse connected.
  • It's an easier alternative to VNC or remote X servers.
  • It allows displaying one HamClock on multiple monitors simultaneously.
  • You can see and control HamClock with your phone (if you dare).
  • It's a more efficient way to run HamClock on a headless Pi. To try this, build hamclock as usual but when you run it add the -x argument to suppress its normal display and run it as daemon. The complete command line becomes:
        hamclock -x &
                    
    You won't see anything on your screen now, but browse to the host running hamclock as above and voilà! you will find a live HamClock.
  • It may be an easier way than using xrandr to get full screen because most browsers have a kiosk mode and they can zoom in or out. For example, on macOS Chrome, zooming in and out is ⌘+ and ⌘- and full screen mode is toggled with ^⌘F. You can also start Chrome in a real kiosk mode from the terminal command line as
        /Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome --kiosk http://<hamclock-address>:8080/live.html
                    
    Other browsers/systems likely have similar controls.

In addition to the live display, HamClock also provides a scripting RESTful command interface, with which it can be controlled and queried over a network. These can be sent with command line tools such as curl or wget or a browser. The list of commands below is followed by several examples.

Syntax Summary
get_capture.bmp Save screen as bmp file
get_config.txt Report current HamClock configuration settings
get_de.txt Report DE info
get_dx.txt Report DX info
get_dxspots.txt Report current list of DX cluster spots
get_satellite.txt Report current satellite position and passes, if defined
get_satellites.txt Show a list of all available satellites.
get_sensors.txt Generate list of BME280 sensor values, if attached
get_spacewx.txt Get last-known pane data and age
get_sys.txt Report some basic HamClock system information
get_time.txt Report HamClock's idea of UTC
set_alarm?state=off|armed&time=HR:MN Set alarm off or arm at the given optional time
set_cluster?host=xxx&port=yyy Set a different DX cluster node
set_defmt?fmt=[one from menu]&atin=RSAtAt|RSInAgo Set DE pane time format to one of its menu choices, and rise/set if All info
set_displayOnOff?on|off Turn display on or off
set_displayTimes?on=HR:MN&off=HR:MN&day=[Sun..Sat]&idle=mins Set display on and off DE times for the specified day, or today if not specified.
DOW is Sun..Sat. Optionally set display idle time (not saved on per-day basis).
set_mapview?Style=S&Grid=G&Projection=P&RSS=on|off&Night=on|off Change 1 or more map settings. S, G and P must match View menu text exactly.
set_newde?grid=AB12&lat=X&lng=Y&TZ=local-utc Define a new DE location using grid or latitude+longitude and optional time zone
set_newdx?grid=AB12&lat=X&lng=Y&TZ=local-utc Define a new DX location using grid or latitude+longitude and optional time zone
set_pane?Pane[123]=X,Y,Z... any set from:

VOACAP DE_Wx DX_Cluster DX_Wx Solar_Flux Planetary_K
Moon Space_Wx Sunspot_N X-Ray Rotator ENV_Temp ENV_Press
ENV_Humid ENV_DewPt SDO_Comp SDO_6173A SDO_Magneto
SDO_193A, Solar_Wind, DRAP, Countdown, STEREO-A

Set the specified plot pane content, if allowed.
set_rss?reset|add=X|file|network|interval=secs Set local RSS titles, see examples below.
set_satname?abc|none Select satellite from built-in list, or none
set_sattle?name=abc&t1=line1&t2=line2 Define a satellite using TLE values
set_senscorr?sensor=76|77&dTemp=X&dPres=Y Set the given BME280 temperature and/or pressure correction in current units
set_stopwatch?reset|run|stop|lap|countdown=mins Stopwatch commands
set_time?ISO=YYYY-MM-DDTHH:MM:SS Set UTC to the given time
set_time?Now Set UTC to current time from NTP or gpsd
set_time?unix=secs_since_1970 Set UTC to the given UNIX time
set_title?msg=my message&fg=R,G,B&bg=R,G,B|rainbow Set call text to msg with fg and bg 0-255 RGB colors; missing args are
left unchanged; changes are not persistent and do not effect real call;
restores all default settings if no args
set_touch?x=X&y=Y&hold=0|1 Virtually touch, or hold, screen coordinate X, Y; scaled to 800 x 480
set_voacap?band=80-10&power=W&tz=DE|UTC Set VOACAP map band and/or power and/or timeline units; disable map if nothing
exit tells HamClock to exit (not ESP)
live.html page with which HamClock can be controlled from a browser (not ESP)
restart Restart HamClock
updateVersion Check for new version and update if found
any command not recognized Show this help

Examples; change the IP to match your hamclock host address.

Get the current clock UTC time:

        curl 'http://192.168.7.101:8080/get_time.txt'
        

Set display to turn on Wednesday at 8 AM and off at 10 PM, DE time, with 10 minutes idle time:

        curl 'http://192.168.7.101:8080/set_displayTimes?on=8:00&off=22:00&day=Wed&idle=10'
        

Set a new DE location from latitude and longitude:

        curl 'http://192.168.7.101:8080/set_newde?lat=40.7&lng=-74'
        

Save the current display to a file named hcscreen.bmp:

        curl 'http://192.168.7.101:8080/get_capture.bmp' > hcscreen.bmp
        

Specify an earth satellite with its TLE:
Note: this TLE will be out of date, it is shown just as an example of proper syntax.

        curl 'http://192.168.7.101:8080/set_sattle?name=ISS&t1=1 25544U 98067A   21320.06051688  .00001570  00000+0  37172-4 0  9998&t2=2 25544  51.6441 311.7573 0004586 201.9414 260.8823 15.48581357312130'

        

Set satellite to ISS and report current ephemeris with respect to DE:

        curl 'http://192.168.7.101:8080/set_satname?ISS'
        

Set Pane 3 to rotate through NOAA Space weather, X-Ray flux and DRAP trend:

        curl 'http://192.168.7.101:8080/set_pane?Pane3=Space_Wx,X-Ray,DRAP'
        

Toggle the screen lock padlock:

        curl 'http://192.168.7.101:8080/set_touch?x=224&y=132'
        

Change call sign to say ON AIR white on red:

        curl 'http://192.168.7.101:8080/set_title?msg=ON AIR&fg=255,255,255&bg=255,0,0'
        

... then restore call sign:

        curl 'http://192.168.7.101:8080/set_title?'
        

Change map to Azimuthal projection with Countries style and RSS on, leaving Grid unchanged:

        curl 'http://192.168.7.101:8080/set_mapview?RSS=on&Projection=Azimuthal&Style=Countries'
        

Turn off RSS network feed and clear the local title list:

        curl 'http://192.168.7.101:8080/set_rss?reset'
        

Turn off RSS network feed and add one RSS title to local list:

        curl 'http://192.168.7.101:8080/set_rss?add=This is a new RSS title'
        

Turn off RSS network feed and load a file containing up to 15 lines into the RSS title list:

        curl --data-binary '@mytitles.txt' 'http://192.168.7.101:8080/set_rss?file'
        

Restore normal network RSS operation:

        curl 'http://192.168.7.101:8080/set_rss?network'
        

Note: as of curl 7.78 URLs with embedded spaces are no longer allowed. Spaces have always been illegal but curl was not enforcing the rule and now it is. To use curl 7.78 or newer when a URL must include embedded spaces:

  • specify --get to force curl to use the GET http method
  • break out the host spec and command portion of the URL as a separate argument to curl
  • set the remaining contents of the URL as a separate argument preceded with --data-urlencode
  • drop the ? altogether in the URL

The examples above that are effected by this change would be rewritten as follows:

        curl --get 'http://192.168.7.101:8080/set_sattle' --data-urlencode 'name=ISS&t1=1 25544U 98067A   21320.06051688  .00001570  00000+0  37172-4 0  9998&t2=2 25544  51.6441 311.7573 0004586 201.9414 260.8823 15.48581357312130'
        curl --get 'http://192.168.7.101:8080/set_title' --data-urlencode 'msg=ON AIR&fg=255,255,255&bg=255,0,0'
        curl --get 'http://192.168.7.101:8080/set_rss' --data-urlencode 'add=This is a new RSS title'
        

Note also that none of this applies if you send commands to HamClock by typing them into your browser. Browsers always perform the proper encoding so embedded spaces are still allowed.

Why do I get an error when displaying a satellite or it disappears after a while?

Probably because your time is off. If the button below and to the right of your call sign says OFF then tap it so it says UTC and try again.

The error occurs because sat elements are only good for a few days so if the clock's time has been adjusted outside the valid range you'll get an error message. Time can be adjusted away from UTC if you click any of the time fields. That can be handy to intentionally move time forward or backwards to explore gray line, VOACAP predictions etc. See page 7 of the User Guide for more details.

Why do I have two HamClocks with identical settings showing slightly different VOACAP maps?

Because they are showing maps for two adjacent hours.

Ideally all Clocks would update at the top of the hour. But with several thousand Clocks running the world over that would overwhelm the backend server. In order to spread out server hits, Clocks intentionally randomize their VOACAP updates throughout each hour. This means the map shown by any given Clock might be up to one hour late.

So in your case, one clock is showing a map for the current hour, and the other is still showing from the previous hour. When the Clock that happens to be updating later updates, it will then show the same map until the cycle repeats next hour.

Why is my grid square wrong?

I can think of two possibilities why you might think so:

  1. You are very near a grid boundary and the HamClock display is misleading because of rounding. For example, suppose you set your location to 35N 110.1W. This is in grid DM45ka. But HamClock will display 35N 110W grid DM45 due to rounding which, unless you know what the internal values are, seems incorrect because 35N 110W exactly is actually in grid DM55. When in doubt, open the lat/long dialog to review the values at full precision.
  2. There are two different algorithms for exactly where a grid square is located. Some programs use the center of a grid for their position, others use the SW corner. HamClock uses the corner because that is the historical technique described in this paper published in January 1989 QST. My personal favorite web site that uses this technique is here. But other popular web sites use the center, such as this one on QRZ.com. So it depends which you consider correct.

If you still feel HamClock is in error, please send me the exact details.

What is the HamClock diagnostic output?

It is additional detailed status and diagnostic information HamClock writes to the file ~/.hamclock/diagnostic-log.txt. It is not intended for general consumption but contains lots of good info for troubleshooting. You may be asked to email me this file if you submit a request for help.

The previous 3 logs are also stored in a rolling set with the following names:

        diagnostic-log-0.txt
        diagnostic-log-1.txt
        diagnostic-log-2.txt
        

If preferred, the diagnostics information can be written to stdout by invoking HamClock as follows:

        hamclock -o
        

What is sudo and set-uid and why should I use them with HamClock, or not?

Sudo stands for "super-user do". In UNIX, the super user refers to extra privileges bestowed upon the root user. Rather than actually logging out and logging back in as user root to gain these privileges, this command arranges for you to have these greater privileges just long enough to run the command that follows on the same line. After that command completes, you are again restricted back to the normal privileges of your current user login.

Another effect of the sudo command is to temporarily change the HOME directory to /root. HamClock creates and uses a working directory named .hamclock (note the leading dot) in the HOME directory. HOME for the normal pi user is /home/pi. Thus, if you run HamClock without sudo it uses /home/pi/.hamclock but if you run it with sudo it uses /root/.hamclock and files therein are not accessible to the normal pi user. This duality can cause much confusion so beware.

set-uid refers to an automatic mechanism engaged by setting the mode of a program file in such a way that when the process runs, it has the same permissions as the owner of the file. Normally, the process has the permissions of the user running the file. Thus by making the program file owned by root, it has super-user privileges no matter what user runs it. Using this mechanism for HamClock allows it to have super-user privileges without using sudo. Unlike sudo, using set-uid does not change HOME, so HamClock will still use your /home/pi/.hamclock directory for its support files, although they will still be owned by root when they are created.

The reason to escalate privileges with either of these methods in the first place is that HamClock requires super-user privileges to perform certain external IO and protected file system operations. It is possible in some configrations for someone with sufficient UNIX administrative knowledge to make adjustments so HamClock can run without super-user privileges, but this is beyond what most users want to deal with. So in the interest of providing the simplest and most enjoyable experience possible for the majority of users, the install instructions use set-uid root.

For those still interested in eliminating the need for root privileges, the following commands may help for RPi. They perform the following functions:

  1. add user pi to various groups to allow necessary IO access
  2. remove the set-uid bit from the executable file
  3. change the group ownership of /usr/local/bin to user pi
  4. allow any user in group pi (specifically user pi) to modify /usr/local/bin
    sudo usermod --append --groups video,input,gpio,i2c pi
    sudo chmod u-s /usr/local/bin/hamclock
    sudo chgrp pi /usr/local/bin
    sudo chmod g+w /usr/local/bin

The last two steps are required so automatic updates may write a new version of the executable file in /usr/local/bin.

After executing these commands, subsequent instances of hamclock will no longer run as root but should be able to perform most functions. But note if you perform sudo make install again in the future this will set the set-uid bit again so remember to perform command 2 again.

Is it possible to change the RSS feeds?

No. RSS feed formats are surprisingly inconsistent so I perform all the heavy lifting on my server and only send the plain titles to the HamClock. Plus, most now use https which uses too much memory for the little ESP processor.

That said, if you have a feed in mind that is of general interest to the global ham community, send me your suggestion and I will consider adding it to the server processing.

You might also consider setting your own titles locally using the set_rss web command (see web FAQ) or run the contributed script hcrss.pl (see the User Contrib tab).

Is it possible to speed up the pane rotation?

In principle, yes. But it would add more stress to my backend server.

Each time HamClock updates a pane it must query my server for that pane's content. With several thousand clocks running the world over, if they all wanted faster pane rotation it would push my server to the limit.

Occasionally I see "WX too fast" or similar -- What does that mean?

It means either my connection to Open Weather Map is overloaded or your clock is making queries too rapidly.

In order to stay within the usage limits of my OWM subscription, my backend server will deny all HamClock weather queries if they arrive faster than 200 per minute.

My server also limits the request rate from any one public IP to no more than once every five seconds to limit abuse. This means if you have more than one HamClock at your home they all count as one for this limit.

Why can't I turn off a pane choice?

Because it's the last one. Panes must always have at least one choice active. If you no longer want the last choice, first select another one, then you can turn off this one.

Is it possible to change the set of satellites?

No. The list is maintained on my server which performs all the heavy lifting of discovery and updating, sending only the TLEs to the HamClock.

That said, if you have a satellite in mind that is of general interest to the global ham community, send me your suggestion and I will consider adding it to the server list.

How are the background maps managed?

As of Version 2.52, the background map images are downloaded and stored as local files as needed. In previous versions they were embedded within the executable image and were thus immutable and limited by size of non-volatile memory.

This meant the ESP HamClocks could only ever support one map style, and even that was only at half the available screen resolution. ESP HamClocks now use the extended FLASH file system to store the map images at full resolution. The improved resolution is especially apparent in the night portion of the Terrain style map. Unfortunately, more pixels and slower FLASH access means the display update rate on the ESP is about 30% slower now but the added flexibility and visual results seem worth it.

The UNIX versions of HamClock store their map files in ~/.hamclock so the number of files is limied only by available disk space.

If you run HamClock without a network connection, you will be limited to map styles already downloaded.

The maps are stored in .bmp format, version 4, using 16 bit RG565 pixels. There are separate files for day and night for each map style. HamClock uses these to render the day and night regions and blends them in a 12° band to simulate civil twilight.

How does the self-update facility work?

When asked to update itself, HamClock checks the support server if there is a newer version available. If so, for the ESP systems this is a binary file that is downloaded directly into FLASH and that's all there is to it.

But for the Desktop UNIX systems, this is a zip file containing the source code that requires many more steps:

  1. the zip is downloaded into a unique directory within /tmp
  2. it is exploded with unzip which creates the source tree
  3. make is run within the source tree, using the same target that was used to build the currently running program
  4. the resulting program file effectly overwrites the currently running program file.

These steps present two challenges: how to find the full path of the program file to a running program and how to update its program file while it is still running.

To find the program file full path, HamClock first checks the argv[0] path given when it was executed, digging through symlinks if necessary to find the real program file. If this is already a full path, indicated by beginning with a slash (/), we are done. If not, then a test is made whether a file with that name exists with respect to the current working directory of HamClock. If so, we are done. If it still is not found, then the argv[0] name is checked for in each of the directories named in the PATH environment variable. If still not found, the update fails.

To update the program file, we have to deal with the fact that it is not possible on UNIX to modify the program file of a running program (even as root). So instead, HamClock does it indirectly by first removing the program file then copying in the new one created by make so it has the same name. To remove the current program file, HamClock requires write permission on its containing directory because removing a file actually just edits it out of its containing directory. If HamClock does not have this permission, the update fails. Copying in the new file then edits the same name back into the same directory, so it looks like it was overwritten when actually it was deleted and added again. Meanwhile, HamClock can continue to run because a deleted file still actually exists in memory until the last process with it open either closes it or exits, even if it is not named by any directory.

How do I use the Bosch BME280 environment sensor on RPi?

On the Raspberry Pi running linux, proceed as follows:

  1. connect the sensor to the RPi using the 40 pin connector as follows:

    BME label RPi Header pin
    Vin 1
    SDI 3
    SCK 5
    GND 9



  2. install i2c-tools:
        sudo apt-get install i2c-tools
    
  3. run sudo raspi-config and set the following options:
        Interface Options ⇒ I2C: enabled
    
  4. Check the Bosch is connected correctly with these tests:
        sudo i2cdetect -y 1
    
    you should see 77 in lower right corner of matrix; then
        sudo i2cdump -y 1 0x77 b
    
    you should see a matrix of different numbers, not just all XX
  5. Start HamClock. Enter Setup, go to Page 2, tap GPIO so it says Active. Also select whether you want metric or imperial units. For now leave the delta values set to zero. Click Done.
  6. After HamClock is up and running again, tap any pane and select one of the ENV plots.
  7. If you have some means of measuring temperature and pressure independent of the BME280, note the errors, restart HamClock and enter the corrections in page 2 of Setup.
  8. Finally, you may add a second BME280 as shown in the following schematic. Note that each has a different I2C bus address depending on whether SDO is grounded.



On a Raspberry Pi running FreeBSD 13.0-RELEASE, proceed as follows:

  1. Connect the hardware the same as above
  2. Test by running sudo i2c -s which should immediately report the device address(es).
  3. Edit /boot/msdos/config.txt to add the following line to the [all] section then reboot and try HamClock.
    gpio=2,3=a0
    

How long can the cable be?

I have used a direct connection of ten feet without any problem. I have also successfully used 100 feet of Cat 5 using a pair of these extenders from Sparkfun.

What if my BME280 always reads 100% humidity?

This may mean your device has become saturated. According to the data sheet page 46, you can try reconditioning the device by baking it at 120 C for 2 hours, then letting it slowly cool to 25 C over 24 hours. If this doesn't help then your device may be broken.

How do I exit HamClock?

Click and hold the padlock for 3 seconds, then select Exit.

What happened to fb0?

Nothing, it's still supported for legacy users, but now that the GUI version can display full screen it is no longer recommended for new installations.

For those new to HamClock who may not know about fb0, it was an early attempt to provide a full screen experience by turning off the GUI and accessing the RPi video frame buffer directly. This was accessed through the special file /dev/fb0, and hence the name. This allowed HamClock to fullfill its charter purpose on RPi of being a stand-alone appliance for ham radio information. Although successful, it required a lot of special programming and could be a challenge for users to install. It is now replaced by using FreeDesktop.org atoms to accomplish the same full screen functionality with the normal X11 GUI.

If you have fb0 installed, please remove it before installing any new versions. This requires the following steps:

  1. log into your RPi with ssh
  2. stop automatically starting hamclock, for example if you used crontab, type crontab -e and remove the line that runs hamclock
  3. Make sure the GL driver is enabled by running sudo raspi-config and doing

    Advanced Options ⇒ GL driver ⇒ OpenGL with fake KMS ⇒ Ok
    don't reboot yet

  4. Restore using the GUI by doing

    System Options ⇒ Boot ⇒ Desktop Autologin ⇒ Ok ⇒ Finish ⇒ Reboot? Yes

Must I use /usr/local/bin for the executable?

No. To build hamclock and put it in, say, /usr/bin, use the following steps:

        cd ESPHamClock
        make -j 4 hamclock-1600x960
        sudo mv hamclock-1600x960 /usr/bin/hamclock
        sudo chown root /usr/bin/hamclock
        sudo chmod u+s /usr/bin/hamclock
        

Why does my screen go blank after a short while?

It's either your host system or HamClock.

On RPi running Bullseye you can turn off screen blanking as follows:

  1. click the red Raspberry in the upper left corner
  2. click Preferences
  3. click Screen Saver
  4. click Display Modes tab
  5. set the Mode to Disable Screen Saver
  6. close the dialog by clicking the X in the upper right corner

As for HamClock, it will only blank the screen if it is in Full Screen mode (set in Setup). If not in Full screen mode, then the blanking must be caused by the host system, not HamClock. Follows are the HamClock settings that control whether it will blank the screen; these settings are only present when in Full screen mode (or on the ESP platform):

  • Check the Idle time in the upper right corner. You may have to click the region to change options to find the value. Click just above or below the Idle number to increase or decrease by 5 minutes. Set to 0 to display idle blanking.
  • Check the Off and On (or Dim) times in the same area. Change them the same way; set the times equal to disable blanking. These can also be set on a daily basis in Setup.

Why is the CPU usage so high on the Pi and other UNIX platforms?

This is a consequence of HamClock being originally written for the ESP8266 embedded processor. I wrote a porting layer that allows me to use the same application code on the Pi. This saves me a lot of effort but since the ESP8266 code is fundamentally an infinite loop, the result is the UNIX program runs all the time also.

It's not usually a big deal in practice but if it bothers you, use the hamclock -t command line argument to set the desired CPU percentage. For example, to limit cpu usage to about 50%, run hamclock as follows:

        hamclock -t 50
        

Note that lower limits will result in more sluggish performance.

What are rigctld and rotctld?

Rigctld is hamlib's rig control daemon, and rotctld is the rotator control daemon. They provide a device independent network protocol to control several brands of radios and single and dual axis antenna rotators without having to know their individual commands. On RPi you can install them with sudo apt install hamlib.

HamClock can create a network connection to these programs for automatic control of any radio or rotator* supported by hamlib. To get a list of all supported equipment run the programs with -l, such as rigctld -l. You must get these hamlib programs working with your equipment before you can use them with HamClock.

For practice, you can run either program in simulation mode by specifying model one, such as rotctld -m 1. Then enter the program's host and port number in HamClock's Setup, page 3. The rotator simulator is particularly fun. Start the simulator, then select the Rotator pane and get acquainted with the controls before connecting to your real rotator. There is no pane dedicated to rig control, it is only used to automatically set the radio frequency of a DX Cluster spot.

Do not confuse rigctld (or rotctld) with another hamlib program named rigctl (or rotctl). This program, without the trailing d, provides direct radio (or rotator) control using the command line, not a network connection. Both the command line and the network program use the same control libraries under the hood, so if one works the other will also. It can be a good idea to use rigctl (or rotctl) for initial testing, then once that works, change to rigctld (or rotctld) using the same -m model selector to allow network control from HamClock.

* Note as a special case, although the Yaesu G5500 rotator is not supported by hamlib because it has no serial or networked computer interface, there is a project that provides a drop-in replacement for rotctld for the G5500 here .

What is flrig?

flrig is w1hkj's program to provide network control of many ham radio transceivers. It historically provided rig control to fldigi but works very well on its own. Unlike the hamlib tools, flrig includes its own GUI so many consider it easier to use.

You can download packages for several platforms here or on RPi you can install it with the command sudo apt install flrig. Once installed, just type flrig and go to Config → Setup → Transceiver to prepare for your radio.

Can HamClock run without a network connection?

It will run but you won't see much.

HamClock connects to clearskyinstitute.com for all the data plots, real-time images and maps and to various NTP servers for time. That just leaves the moon, NCDXF beacons, terrain and country maps, and BME environment data that is sourced locally.

You could get time without a net connection by using a GPS antenna and running gpsd.

Why does HamClock report K index and not A?

Because K is more timely. The K index is reported every three hours while the A index is only updated once per day. You can find the exact relationship between A and K in the WikiPedia article.

Why does HamClock report a different value compared to XYZ?

It could be a different source or different timing.

There are multiple resources for most statistics and they can differ by a small amount. For example, the sun spot numbers are determined and reported independently by NOAA in the US and SILSO in Belgium.

It can also be due to timing. The various primary data sources publish at different times during the day and they are not always exactly on time. The secondary data consumers also have their own schedule of picking up the values which can also vary. For example, DRAO Penticton publishes new SFI each day at 17:00, 20:00 and 23:00 UTC but WWV often does not pick them up until a few hours later. Even WWV sources are not always in sync. Typically their json feed is several hours ahead of their text feed.

My question is not here, where can I get help?

Send me a note at ecdowney@clearskyinstitute.com but beware:

  1. Be polite or your email will simply be discarded.
  2. If you installed or purchased HamClock using someone else's instructions, contact them, not me.

If you are submitting a bug report, always include:

  1. HamClock version
  2. platform: ES8266 or UNIX/linux distro and version
  3. a clear and concise statement of what you expected to see ...
  4. ... what you actually saw ...
  5. ... and instructions for how to reproduce the unexpected result.

If using any UNIX system, also include the following as you feel might be helpful:

  • which make target you built
  • display screen size and video type such as DSI or HDMI
  • whether you are using VNC
  • whether you are using GUI in Full-screen mode
  • pertinent Setup settings
  • a copy of all ~/.hamclock/diagnostic-log*.txt log files

Thank you. Your coorperation will help us both find a resolution to your issue more quickly.

All contributed scripts referred to below are available in this zip file

Tips for Executing and Displaying HamClock on Windows 10

Contributed by Joeri van Dooren, ON3URE

  1. In windows download https://sourceforge.net/projects/vcxsrv
  2. Install; choose single windows
  3. In Windows install WSL2 with ubuntu.
  4. Start wsl.exe
  5. sudo apt update
  6. sudo apt -y install g++ libx11-dev wget
  7. wget https://www.clearskyinstitute.com/ham/HamClock/ESPHamClock.zip
  8. unzip ESPHamClock.zip
  9. cd ESPHamClock
  10. make hamclock-800x400
  11. sudo make install
  12. export DISPLAY=:0
  13. /usr/local/bin/hamclock

Automating qrz page from spots

Contributed by Hans Klausmann, DL5RAZ



        

Script to simplify sending web commands from command line

Script by Barry, N0NZ

Documentation here.




        

Script to read and write the eeprom config file

Contributed by Elwood Downey, wb0oew@arrl.net

Someone asked if they could edit the eeprom config file. Normally no, but since I enjoy writing perl, I couldn't resist writing hceeprom.pl to do exactly that. You can download it within the contrib collection here.

Save the script anywhere in your PATH and make it executable as usual. Cd into the ESPHamClock source directory to run it. This location is required because the script needs to read the HamClock.h and nvram.cpp source files to find the symbolic names, lengths and descriptions of the various parameters saved in eeprom. The script assumes the eeprom file itself is located in ~/.hamclock/eeprom. The type of the parameter is not saved in the eeprom file, so the script also needs to know the data type, which you must include on the command line using i for integral, f for float or s for string. Run the script with no args or --help for a usage summary.

Note well: you are hacking a file not intended for human consumption, so you can easily mess things up. There's no validation checking whatsoever, so you could go right ahead and set preposperous values such as a longitude of 10000 or inconsistent values such as a lat/long that doesn't match the grid square sending HamClock into unexplored territory. Save a copy of eeprom before starting, or remove it and HamClock will build a new one when it starts containing all defaults. Never edit the file while HamClock is running because HamClock often updates it, but only reads it once when starting up. You have been warned.

No matter, let's try it! Here are some examples:

Read the call sign:

        hceeprom.pl NV_CALLSIGN s
        NV_CALLSIGN = WB0OEW
        

Set a new call sign:

        hceeprom.pl NV_CALLSIGN s AB1XYZ
        NV_CALLSIGN = AB1XYZ
        

Set the DX cluster host:

        hceeprom.pl NV_DXHOST s usdx.w1nr.net
        NV_DXHOST = usdx.w1nr.net
        

Set DX spots to show as full call sign

        hceeprom.pl NV_MAPSPOTS i 2
        NV_MAPSPOTS = 2
        

Set the BME280 at I2C address 77 temperature correction:

        hceeprom.pl NV_TEMPCORR2 f -0.23
        NV_TEMPCORR2 = -0.23
        

Here's the script:



        

Script to query for any space weather datum

Contributed by Elwood Downey, wb0oew@arrl.net

This script queries HamClock for the most recent value of any space weather data it provides. Run the script with -help for a complete list.


 
        

Script to send any RSS feed to HamClock

Contributed by Elwood Downey, wb0oew@arrl.net

HamClock does not allow setting individual RSS feeds, see FAQ for the reason why. But this script uses the web-based RSS title loading facility set_rss to read any RSS feed and load its titles into HamClock.

To use the script, just give it the host name (or IP) of your HamClock followed by the full URL of the RSS to load. For example:

        hcrss.pl 192.168.7.117 https://www.arrl.org/news/rss
        

 
        

Instructions for macOS dual screen

Contributed by AL7CR.

These settings allow a full screen Hamclock with no menu or borders on one display and a fully useable Mac desktop on the other. Tested on XQuartx 2.7.11 under High Sierra 10.13.6. The steps are:

  1. Set "Displays have separate spaces" otherwise running HamClock will cause the second screen to be black whether or not it is set to full screen mode.
  2. Set "Assign to Display" to the desired display. This is done by right clicking the XQuartz icon in the dock and selecting the desired display. This option only appears if you have multiple displays.
  3. Autohide Dock and Menubar as for a single screen. Note that this setting is system wide and not per screen as you might expect.
  4. And the key point, in XQuartz preferences disable full screen mode. If this is not done Hamclock will disappear when it's window loses the system focus. Command-Option-A will make it reappear however you will not be able to work in one screen with Hamclock in the other unless XQuartz full screen is disabled.

Arch User Repository

Contributed by KJ7RRV.

HamClock is available in the Arch User Repository here. The package names are:

  • hamclock (800x480)
  • hamclock-big (1600x960)
  • hamclock-bigger (2400x1440)
  • hamclock-huge (3200x1920)

Building the ESP8266 software

  1. Install the Arduino IDE from here. I am currently using version 1.8.16.
  2. Open Preferences. In the field labeled Additional Boards Manager URLs copy/paste the following line then click Ok:
        http://arduino.esp8266.com/stable/package_esp8266com_index.json
    
  3. Open Tools → Boards → Boards Manager
  4. Search for "esp8266"
  5. Select version 2.7.4 then click Install.
  6. Open Tools → Manage Libraries, set Type and Topic to All, then search for and install the following libraries:
    • Adafruit GFX (all), version 1.10.2
    • Adafruit Unified Sensor, version 1.1.4
    • Adafruit BME280, version 2.1.1
    • Adafruit RA8875 (only), version 1.4.0
    • Time, version 1.6.0

    Other versions might work but these are the versions I am using now.

  7. Quit and reopen the Arduino IDE
  8. Connect your computer to the Huzzah with a USB port
  9. Open Tools → Board → ESP8266 Boards and select Adafruit Feather Huzzah ESP8266
  10. Download current stable HamClock release here. Unzip it anywhere you wish, but probably best to use the default sketch folder.
  11. Use File → Open and find the ESPHamClock.ino file you just unzipped. This will create a new project.
  12. In the IDE Tools menu make the following selections (click for larger view):

    ide

    Set the port to match the USB connection of your Huzzah.

  13. Run Sketch → Verify/Compile then Sketch → Upload
  14. Your HamClock should start running. Read the User Guide and have fun.

Using the 9" display

To use a 9" ER-TFTM090-2 from buydisplay.com:

Select these options during purchase:

  • Pin header 4 wire SPI
  • VDD 5 V
  • Touch panel 9" resistive
  • Micro SD - none
  • Font chip - none

This is the wiring list:

	    EP = ESP Huzzah
	    BM = BME280 sensor
	    PC = photo cell
	    DP = display

	    EP_SCL    BM_SCK
	    EP_SDA    BM_SDI
	    EP_3V     BM_VIN
	    EP_GND    BM_GND

	    EP_ADC    PC_1, 330k
	    EP_GND    PC_2
	    EP_3V     330k

	    EP_SCK    DP_8
	    EP_MO     DP_7
	    EP_MI     DP_6
	    EP_2      DP_5
	    EP_16     DP_11
	    EP_USB    DP_3, 4, 37, 38
	    EP_GND    DP_1, 2, 13, 31, 39, 40
        

Pros:

  • Larger, brighter, richer colors
  • Simpler wiring because you do not need the RA8875 or flat cable

Cons:

  • Requires a very good USB supply, at least 2 A. This one from Adafruit is known to work well.

Stand ideas

The display stand from Adafruit can be made to work with a little ingenuity but is not perfect for the LCD. Send suggestions for better ideas and I will post here.

  • One alternative I found is this video that suggests normal picture framing components could be used.
  • The stand from Adafruit is actually made by Pimoroni so I asked them for better suggestions. They said they know of no stand suitable for the Adafruit LCD but thought this one might be pressed into service with less effort.
  • G3XOU used this RPi screen support with some assembly details here .
  • KF5LW suggests adopting this RPi screen support. He said he 3D-printed a piece to the RPi dimensions then it worked well.
  • W3TMC sent a photo of the nice looking oak stand he built.
  • N2YTF did a nice job with some simple wood and a breadboard. He sent photos here and here.
  • N6ROB attached the components and display to the stand with hot glue after sanding and wiping down with alcohol. The result looks clean and efficient.
  • N7EEK has taken a minimalist approach that works well using a $9 stand from Amazon. See his photos here.
  • ON4AEY made a nice clock and sent me this link to share.
  • N7LVS made this YouTube video showing his construction technique.
  • HB9AJG shared his very nice arrangement from the front, back and in his shack.
  • HB9CEY shared his tilt stand front, rear, inside and on display.
  • WA1TOV put his in a clear frame he found here. He comments: The back of the display is glued to the face of the frame. You might be able to see round glue dots in the rear view photos. I used E6000 glue. To do this I had to cut a 1.5" slot in the frame to feed the ribbon through. This was done with a Dremel and cut off wheel, just working very carefully and then cleaning it up with a jeweler's file. Photos: front, side and rear.

If you find your display idea works better when the cable exits from the top, there is an option in the Setup screen that allows you to flip the display upside down.

Here is how I built my first two prototypes:

Shack photo showing 7" version.

Rear of 7" version

Both the 7" and 9" versions.

Rear of 9" version

HamClock would not be possible without the following resources:

And big Shoutouts to Adafruit and Raspberry Pi Foundation for great products and support.

This is a guide to the touch controls and map symbols of HamClock. A printable version is also available.











HamClock was originally developed for the ESP8266 such as the Adafruit Huzzah. But after I created a porting layer, it may now also be built for Raspberry Pi, macOS, Ubuntu, FreeBSD, Windows WSL or most any other UNIX-like system supporting the X11 Windows system.

Instructions are below, but first a few preliminaries:

To install HamClock on a Raspberry Pi follow these steps:

  1. These instructions assume your RPi is up and running Bullseye. If not, first see the FAQ about being new to the Pi then come back here.
  2. Open a terminal on the target system GUI desktop by clicking on the red Raspberry → Accessories → Terminal. This will give you a command line prompt for the next step.
  3. Download the installer script by running the following commands (use copy/paste to avoid typos):
    cd
    curl -O http://www.clearskyinstitute.com/ham/HamClock/install-hc-rpi
    chmod u+x install-hc-rpi
    
  4. Now run the script by typing the following command. Answer each question by typing y or n followed by Enter:
    ./install-hc-rpi
    
  5. If something goes wrong, look through the detailed instructions in the next section. But if all goes well that's it! Be sure to read the User Guide to get the most from HamClock.
  6. If you chose not to install a desktop icon, you can run HamClock from the terminal at any time by typing this command:
    hamclock &
    

To install HamClock on other UNIX-like systems follow these steps:
(works for RPi too if you prefer the scenic route)

  1. Open a terminal directly on the target system GUI desktop to get a command line prompt.

    Do not use ssh unless you know what ssh -X means.

  2. Run these commands (use copy/paste to avoid typos):
    cd
    rm -fr ESPHamClock
    curl -O https://www.clearskyinstitute.com/ham/HamClock/ESPHamClock.zip
    unzip ESPHamClock.zip
    cd ESPHamClock
    make -j 4 hamclock-800x480
    sudo make install
    
    • If you get errors:
      • on Raspberry Pi try loading these packages:
            sudo apt-get update
            sudo apt-get -y curl install make g++ libx11-dev xserver-xorg raspberrypi-ui-mods lightdm lxsession openssl
            
      • on Ubuntu try loading these packages:
            sudo apt install curl make g++ xorg-dev
            
      • on macOS try installing XQuartz and Xcode. Then run
      •     xcode-select --install
            
      • on FreeBSD try loading these packages:
            sudo pkg install gcc libX11 gmake curl
            
        then use gmake instead of make.
      • on Fedora 34 try loading these packages:
            sudo yum install gcc-c++ libX11-devel
            
  3. Now run HamClock by typing:
    hamclock &
    
  4. Be sure to read the User Guide to get the most from HamClock!
  5. To exit hamclock, click and hold the padlock icon for three seconds, then choose Exit.
  6. The example make command above will build HamClock with 800x480 pixels. You can also make these sizes:
    • hamclock-1600x960
    • hamclock-2400xx1440
    • hamclock-3200x1920
    If you do, redo both make commands again, for example:
    cd ~/ESPHamClock
    make -j 4 hamclock-1600x960
    sudo make install
    
  7. If you would like HamClock to fill the screen, set that option on Page 2 of Setup. With this option HamClock will still be the same screen size you built, but it will fill any surrounding gap with black so there is nothing else showing. If you really want HamClock to use all available screen space, see the FAQ about making different sizes with xrandr.
  8. If you would like a Desktop icon with which to start HamClock on RPi, try these commands:
    cd ~/ESPHamClock
    mkdir -p ~/.hamclock
    cp hamclock.png ~/.hamclock
    cp hamclock.desktop ~/Desktop
    
  9. If you would like HamClock to start automatically when you boot your RPi, try these commands:

    cd ~/ESPHamClock
    mkdir -p ~/.config/autostart
    cp hamclock.desktop ~/.config/autostart
    
  10. On macOS, you can turn the bare executable into a clickable App on your Desktop as follows:
    cd ~/ESPHamClock
    HCDIR=~/Desktop/HamClock.app
    mkdir -p $HCDIR
    echo '#!/bin/bash' > $HCDIR/HamClock
    echo '/usr/local/bin/hamclock &' >> $HCDIR/HamClock
    chmod u+x $HCDIR/HamClock
        

    To give it a proper icon:

    1. open hamclock.png with Preview
    2. click on the image
    3. type ⌘-A to select the image
    4. type ⌘-C to copy the image to the clipboard
    5. right-click the new HamClock.app Desktop item and select Get Info
    6. click the existing default icon in the upper left corner
    7. type ⌘-V to paste a new icon
    8. close Get Info
    9. close Preview

    To put it in the Dock:

    1. edit the script and temporarily remove the trailing & (dock icons bounce until the parent process exits)
    2. double-click to launch HamClock.app
    3. while it's bouncing in the dock, right-click and select Options → Keep in Dock
    4. exit HamClock
    5. remember to put back the &

    For a little more decorum, create a bona fide app using Platypus. I tried it briefly on Big Sur and found it easy to use and worked well. Use the same 2-line script as above but without the & so Platypus can properly inform the OS when you exit HamClock.

This site does not use cookies.