vfo-knob-setup

The setup firmware

Every knob ships with the setup firmware (vfo-knob-setup). It does two things, with nothing but a phone: it puts the knob on your WiFi, and it installs the firmware for your radio. Later, any radio's firmware can hand the knob back to it, to install another.

The pictures below are the knob's own screens; the orange marks are what your hand does.

Just got your knob? It left the workshop with the firmware of the day it was made: update it over its cable first, from Chrome or Edge on a computer — under a minute — then follow the steps below.

1. Power on

The RF.Guru splash, then the setup firmware says it is starting.

VFO-KNOB, Starting

If the knob already knows a WiFi network, it spends up to 25 seconds joining it, and goes straight to the firmware list. Otherwise it opens a hotspot of its own.

Unplugged, on its own battery, the knob shows its charge at the top, over each screen's title, as a phone does: full to empty by the quarter, green from half its charge up, yellow under that, red at a fifth and below. On USB power the charge cannot be read, and none shows.

On its own battery: the knob's charge over the title

2. Join the knob's hotspot with your phone

The knob comes up as an open WiFi network, VFOKnob, and says so.

WIFI SETUP: join the WiFi network VFOKnob with your phone

Join VFOKnob on your phone. The phone opens the knob's WiFi page by itself, the way a hotel's sign-in page opens; if it does not, browse to http://192.168.4.1.

3. Choose your network

The page lists the networks the knob can hear, strongest first. Tap yours, enter its password — Show shows it as you type, so a phone's keyboard cannot quietly change it — and tap Connect.

The knob's WiFi page on a phone

The knob tries the network and says how it goes, on its face and on the page:

On the knobOn the phone
Joining HomeNetwork Connected to HomeNetworkConnected to HomeNetwork: now choose the firmware on the knob's dial

If it cannot join, both say why — wrong password?, network not found — and the page lets you try again. Once it is on, the hotspot goes away after a few seconds; the phone can be put away.

No phone at hand? With the knob on a computer's USB-C cable, set its WiFi from Chrome or Edge instead.

4. Choose your radio's firmware

The first time it is on the network, the knob first puts every firmware published onto its SD card, one after another, and says how far it has got. It takes a few minutes, once. Whichever you then choose installs from the card in a few seconds, and the knob can go from one firmware to another later without a network. See The SD card.

SD CARD: the firmwares onto the card, 3 of 17

The knob looks up the firmwares published for it, with their versions, and shows them on the dial, one a detent. Turn to your radio's and tap the panel. A name too long for the panel is shown in smaller type, so it fits.

FIRMWARE: INSTALL SVXConnect and its version — turn to choose, tap the panel to install

FirmwareFor
AetherSDRAetherSDR on a computer, over the USB cable or WiFi (TCI)
Icomthe IC-705, IC-7610, IC-9700 and the IC-R8600 receiver, over the radio's own LAN
FlexRadioa FLEX-6000/8000 as a MultiFlex station, on the LAN or through SmartLink
SVXConnectan SvxLink reflector: the knob is the station
UberSDRan UberSDR web receiver, receive only, with its spots and SSTV pictures
Kiwi888KiwiSDR and Web-888 web receivers, receive only: up to four, another a swipe away, a second in the right ear
OpenWebRXOpenWebRX and OpenWebRX+ web receivers, receive only: up to four, by their addresses
WebSDRPA3FWM's WebSDR receivers (websdr.org: Twente and the others), receive only: up to four
Telephonea SIP telephone account: the knob is the handset
EpiBeama phased array's beam switch, a 4-square or 8 directions, for EpiCenter: a beta
ADS-B Radara radar of the aircraft round you, from an ADS-B feed or your own receiver
Clocka clock for the shack: local time, UTC, four faces, ten alarms
Weathera weather station for one place, from Open-Meteo's forecast
WiFi Testthe WiFi network measured, for a knob whose links drop: its signal, every drop and why, pings, the channels

A firmware still in beta is stamped BETA in the panel's corner: it is published for those who want to try it, before it has been tried widely.

A firmware still in beta, stamped BETA

The list comes from the update server each time, so a knob set up long after it was made still offers every firmware there is by then. The last entry is WIFI — Set up again: it brings the hotspot back, for another network.

WIFI: Set up again

5. It installs, and restarts into it

The knob downloads the image, checks its signature, installs it and restarts into it. It keeps the WiFi settings: the new firmware joins the same network. With an SD card in the knob, a copy of the image is kept on it, and a firmware already there installs from the card in a few seconds — see The SD card.

InstallingDone
UPDATING 64% — Do not unplugUPDATING 100% — Restarting

Then tell the knob where its radio is, on its configuration page: see the guide for that firmware.

Back to the setup firmware, from any radio's

To install another radio's firmware, go back to the list from the knob itself.

  1. Hold a finger on the S-meter, at the top of the face, until the knob clicks: the address card comes up — the firmware and its version, the knob's power (on USB power, or battery 85 %), then its addresses. Let go.

    The address card, held up on the S-meter

  2. Hold the S-meter (or the card) again, for three seconds, until the knob buzzes. It asks FIRMWARE? — turn the knob for yes. A tap, or ten seconds of nothing, says no.

    FIRMWARE? turn the knob for the picker

  3. The knob restarts, installs the setup firmware — the newest published, once it is on WiFi (from its SD card when the card holds that one), or the card's own where no network comes within about 20 seconds — and shows the list again, the WiFi settings kept.

    REBOOTING into update mode

With something wrong — NO LINK, say, on a knob with another radio's firmware — the warning panel shows the addresses in the card's place: hold that until the knob buzzes. Without the setup firmware on its SD card it needs WiFi: on the USB cable the knob then says Needs WiFi and carries on as it was.

Each firmware keeps its own settings, so going back to one later finds its radio, its login and its choices as they were. With an SD card in the knob they are kept on the card (see The SD card).

Another network, later

The knob keeps up to four WiFi networks — home, and a phone's hotspot, say — and joins whichever is in reach, the one it joined last first. A network chosen on the phone's page is added to them, not put in their place.

Take the knob where none of them reaches, and whichever firmware it runs puts up VFOKnob again after about 25 seconds, with WIFI SETUP on its face: join it with your phone and choose a network, as above, and the knob goes on with its radio. It keeps looking for the networks it knows meanwhile, so back home it simply joins again. Not over the cable: with a computer on it, the cable is the way.

None of its networks is in reach: join VFOKnob with your phone to add one

The configuration page lists them under WiFi: add one there, give one a new password, or remove one.

Or add one from a computer, over the knob's cable.

The SD card

The knob keeps a copy of its firmwares on its microSD card. The setup firmware fills it with every one published: those the card has none of before it shows the list, with the screen above, and newer versions of the others in the background while the list is up. Every install puts its image there too. A firmware already on the card installs from it in a few seconds, its checksum and signature checked as for a download. So:

  • switching firmware is quick, and going back to the setup firmware works without any network at all;
  • with the update server out of reach, the setup firmware lists what is on the card, From the SD card, and installs from it.

The card keeps the second chip's firmware too, the Bluetooth headset's and speaker's: the setup firmware puts it there with the others, and a radio's firmware hands it to the chip by itself when it is newer than the one the chip runs — see the headset guide.

The card also keeps every firmware's settings, in a folder of their own, VFO-CFG: the radios and their logins, the levels, the page's password, SVXConnect's key and certificate, the telephone's account, history and favourites, the SmartLink and Google sign-ins, the receivers. Each is kept in three copies, written in turn and read back, so a power cut never leaves them half-written: the knob starts with them as they were saved. The WiFi networks and the Bluetooth devices stay in the knob itself.

The firmwares are in VFO-KNOB, the settings in VFO-CFG; nothing else on the card is touched. A knob without a card works as before, downloading each time and keeping its settings in its own memory.

The card is built in. Should it fail and stop answering, the knob runs on what it has in its own memory, keeps your changes there, and says NO SD CARD; a restart tries the card again, and your changes go onto it once it answers. The configuration page says the same under Settings, with Carry on without the SD card for a card that has failed for good (and, should it answer again later, Use the SD card again), and Prepare this card for one that answers but can no longer be read: that erases it and puts the settings on it.

NO SD CARD: the card that holds the settings does not answer

SD CARD FAULT: part of the settings could not be read

Safe mode

A knob that restarts three times in a row before it has been up 20 seconds is taken to be stuck in a crash, and the next start comes up in safe mode: WiFi and audio off, and the settings' card left alone, so that what crashed it is not started again. The face says SAFE MODE. Restart the knob, or unplug it and switch it off and on: the count is cleared once safe mode has been up 20 seconds, so the next start is an ordinary one. A restart asked for on the configuration page, or a radio chosen on the dial, does not count, nor one from a computer on the USB cable: the website's pages and esptool restart the knob as they open its port.

SAFE MODE: three failed starts in a row

The setup firmware says so over the whole face, and after 20 seconds that a restart brings it back.

SAFE MODE on the setup firmware: restart it

If something is not right

The knob saysWhat to do
Could not join network: wrong password?Check the password on the phone's page and connect again.
Could not join network: network not foundThe network is out of reach, or a 5 GHz-only one: the knob uses 2.4 GHz.
None found. Is the network online? Trying again.The knob is on the network but cannot reach the update server; it keeps trying.
WiFi would not start.Restart the knob.
WIFI SETUP: None of its networks is in reach (a radio's firmware)Join VFOKnob with your phone and add the network where the knob is now, or take it back within reach of one it knows.
Needs WiFi (from a radio's firmware)The way back to the list is over WiFi: set up WiFi on that firmware's page, or use Set up again.
NO SD CARDThe built-in card that holds the settings does not answer: restart the knob. If it stays, the card has failed: Carry on without the SD card on the configuration page, and the knob keeps its settings in its own memory.
SAFE MODEThree starts in a row ended before 20 seconds, so this one runs without WiFi, audio or the settings' card: restart the knob, and it starts as usual. If it comes back to SAFE MODE every time, something crashes it at every start: install its firmware again over the USB cable.
SD CARD FAULTPart of the settings could not be read from the card, or it stopped taking writes: the knob runs on its own memory meanwhile. Restart it; the page's Settings says which part, and offers Start fresh on this card when the settings have gone from it.

If it goes on, or the knob does anything else it should not, tell us: Report a problem, at the bottom of the knob's configuration page, gathers what the knob knows of it and opens a bug report on GitHub with that filled in. See Reporting a problem.