Dialog for setting user-defined frequencies #1417

jirimaier · 2024-04-30T00:32:25Z

XCSoar can set the frequency of a radio. However, this is currently only possible for frequencies that are tied to an airfield (defined in a waypoints file). This PR proposes a dialog that shows a list of user-defined frequencies. the frequency list is editable via GUI and stored in user.freq file in XCSoar's root directory.

This will be particularly useful for frequencies like:

glider air-to-air
FIC
emergency

lordfolken · 2024-04-30T05:53:56Z

Hey,
So i'm all for expanding the radio control situation, which is currently providing little advantage over entry directly on the device.

I think a favourites list like this, that can be activated by tapping on the radio infobox, or called up via a menu option, is a good thing.

What i would like to avoid, is yet another file that has to be managed by the user, outside of xcsoar.

So please consider:

User editable from the application
Saving stations in the profile

DanD222 · 2024-04-30T07:16:30Z

@lordfolken Would you be OK with an incremental approach, i.e. get the functionality of reading from a file and sending the frequency to a radio done first, and then expand the XCSoar editing features?

Edit - incremental.. shouldn’t try to use fancy words.

jirimaier · 2024-04-30T08:34:36Z

Hello,

This is a draft that is far from finished. I mainly wanted to have such a discussion about proper implementation, so thank you for sharing your ideas.

I already have an intention to add GUI controls for editing the list. New/Edit/Delete, maybe Copy would also be useful.

I also don't like storing it in a separate file; storing it in preferences may be a good option. However, I would like to have a way to load/transfer a larger amount of frequencies quickly rather than typing them manually (for example there are going to be 8 air-to-air frequencies for cross-country gliding in Czechia this year). Maybe I can store it in preferences and add some import/export button that would load/create the frequencies file.

Or I can think of a hybrid approach, where the frequencies will be loaded from both preferences and a file. In that case, it is questionable how to order them in the list (I'd like to let the user select the order rather than sorting them by name, but when they come from multiple sources, this is not so simple), and also whether the user should be able to edit the separate file (from GUI) or only those in preferences.

lordfolken · 2024-04-30T09:02:11Z

@lordfolken Would you be OK with an incremental approach, i.e. get the functionality of reading from a file and sending the frequency to a radio done first, and then expand the XCSoar editing features?

Edit - incremental.. shouldn’t try to use fancy words.

The problem with that is, that you would have to code the migration path as well. As users expect "everything to just work". So i'd rather have the functionality first.

lordfolken · 2024-04-30T10:45:02Z

I also don't like storing it in a separate file; storing it in preferences may be a good option. However, I would like to have a way to load/transfer a larger amount of frequencies quickly rather than typing them manually (for example there are going to be 8 air-to-air frequencies for cross-country gliding in Czechia this year). Maybe I can store it in preferences and add some import/export button that would load/create the frequencies file.

Potentially you could also create an import/export text field, where a csv or multiline file could be pasted/copied. The result of which would go to the profile.

An additional option would be to add a "to favorite" button in airspace and waypoint dialogs.

DanD222 · 2024-04-30T12:01:49Z

On the other hand, thinking about it more, if we settle on where the frequencies will be stored (IMO a separate csv is better than in the preferences because if the frequencies are stored in the preferences then you'd need to ensure compatibility of preferences with frequencies / without frequencies), then the only difference would be handling reading from the csv file as the data source vs also writing to it.

Plus there would be a clear separation of functions, i.e. I don't believe XCSoar stores the checklist in the preferences either, and if you mess up editing the frequencies file, for example if you don't want to input all your initial frequencies through XCSoar, then you wouldn't potentially be left with a non-functioning preferences file.

But of course I could be missing something.

kobedegeest · 2024-04-30T14:17:49Z

maybe you know but just in case #867 tried a similar thing i believe.

And about how to save/ store the data why not do something similar to how markers are saved? User never has to make or edit a file but if you want to you totaly could.

jirimaier · 2024-04-30T14:46:45Z

What about taking the Waypoit Editor as a precedent?
The user would create/edit the list in GUI and it will get saved in a file (let's name it user.freq).
There is no need for the user to ever touch the file, but they can still copy it to another device if they want to.

lordfolken

When saving the frequencies on manage mode somehow the MessageBox blanks the background

Please make the frequencies dialog also accessible from the Active/Standby infoboxes via the touch menu.

src/Dialogs/Frequency/dlgFrequencyEdit.cpp

src/Dialogs/Frequency/dlgUserFrequencyList.cpp

lordfolken · 2024-05-05T21:41:59Z

A numpad kind of keyboard entry widget for numbers/frequencies would be a welcome addtion.

lordfolken · 2024-05-05T21:53:06Z

src/Dialogs/Frequency/dlgUserFrequencyList.cpp

+    set_standby_button = dialog.AddButton(_("Set Stand-by"), [this]()
+                                          { SetClicked(false); });
+    edit_mode_button = dialog.AddButton(_("Edit"), [this]()
+                                        { dlgUserFrequencyListWidgetShowModal(true); 


lordfolken · 2024-05-05T21:54:02Z

src/Dialogs/Frequency/dlgUserFrequencyList.cpp

+  if (dlgFrequencyEditShowModal(item) == FrequencyEditResult::MODIFIED)
+  {
+    list[GetList().GetCursorIndex()] = item;
+    listUpdated(); 


lordfolken · 2024-05-05T22:10:45Z

Invalid lines in user.freq get erased when saving. The question is whether this should be handled or not.

lordfolken · 2024-05-06T00:26:18Z

Ive had several crashes when saving on android. Guess we more error handling.

05-06T00:26:34Z] cannot open /storage/emulated/0/Android/data/org.xcsoar/files/lua/init.lua: No such file or directory
./src/RadioFrequency.hpp:71: unsigned int RadioFrequency::GetKiloHertz() const: assertion "IsDefined()" failed

jirimaier · 2024-05-06T17:03:01Z

When saving the frequencies on manage mode somehow the MessageBox blanks the background

This behavior is same as in the Waypoint Editor. Perhaps it can't be avoided, because the message box is shown after the dialog is closed. I may show the message box after clicking Close button and closing the dialog after Yes/no is selected. However, the behavior would then be different for Close button and closing by escape key.

jirimaier · 2024-05-06T17:07:55Z

Invalid lines in user.freq get erased when saving. The question is whether this should be handled or not.

I have an idea: if the file contains invalid line and user opens the edit/manage screen, show message box saying "There are invalid lines and they will be deleted if changes are saved" and immediately set the 'modified' flag to show the "save changes" prompt after closing even if no changes were made.

lordfolken · 2024-05-08T11:56:01Z

src/Dialogs/RadioFrequencyEntry.cpp

+  value = RadioFrequency(entry.GetRadioFrequency());
+
+  return true;
+}


missing newline

lordfolken · 2024-05-08T11:57:28Z

src/Widget/EditRowFormWidget.cpp

+{
+  const RadioFrequencyDataField &df =
+    (const RadioFrequencyDataField &)GetDataField(i);
+  assert(df.GetType() == DataField::Type::RADIO_FREQUENCY);


Asserts are not on in non-debug mode. Can you add a check if invalid?

lordfolken · 2024-05-08T11:58:12Z

Good work on the Frequency dialog. Really cool. :-)

xtophe80 · 2024-05-08T22:52:04Z

In case it is useful, I have pushed my rebased version of #867 mentioned last week in my repo: https://github.com/xtophe80/XCSoar/tree/FrequencyCard2

jirimaier force-pushed the FrequenciesDialog branch 2 times, most recently from 05e119a to 64f2cce Compare April 30, 2024 00:43

jirimaier force-pushed the FrequenciesDialog branch 7 times, most recently from 736be21 to bfcbc48 Compare May 3, 2024 09:10

jirimaier marked this pull request as ready for review May 3, 2024 09:25

jirimaier requested a review from a team as a code owner May 3, 2024 09:25

lordfolken requested changes May 5, 2024

View reviewed changes

src/Dialogs/Frequency/dlgFrequencyEdit.cpp Outdated Show resolved Hide resolved

src/Dialogs/Frequency/dlgUserFrequencyList.cpp Outdated Show resolved Hide resolved

lordfolken reviewed May 5, 2024

View reviewed changes

jirimaier force-pushed the FrequenciesDialog branch from bfcbc48 to 90a2da5 Compare May 7, 2024 15:56

jirimaier marked this pull request as draft May 7, 2024 18:25

jirimaier force-pushed the FrequenciesDialog branch from 90a2da5 to c50e9b1 Compare May 8, 2024 09:24

jirimaier force-pushed the FrequenciesDialog branch 3 times, most recently from b755b5a to c188422 Compare May 8, 2024 10:14

lordfolken reviewed May 8, 2024

View reviewed changes

jirimaier force-pushed the FrequenciesDialog branch 6 times, most recently from 774c5eb to e41a353 Compare May 11, 2024 09:48

jirimaier added 2 commits May 11, 2024 12:23

Added DataField for radio frequency

e6339c1

Added dialog for setting user-defined frequencies

cea1d58

jirimaier force-pushed the FrequenciesDialog branch from e41a353 to cea1d58 Compare May 11, 2024 10:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Dialog for setting user-defined frequencies #1417

Dialog for setting user-defined frequencies #1417

jirimaier commented Apr 30, 2024 •

edited

lordfolken commented Apr 30, 2024

DanD222 commented Apr 30, 2024 •

edited

jirimaier commented Apr 30, 2024

lordfolken commented Apr 30, 2024

lordfolken commented Apr 30, 2024

DanD222 commented Apr 30, 2024 •

edited

kobedegeest commented Apr 30, 2024

jirimaier commented Apr 30, 2024

lordfolken left a comment

lordfolken commented May 5, 2024

lordfolken May 5, 2024

lordfolken May 5, 2024

lordfolken commented May 5, 2024

lordfolken commented May 6, 2024 •

edited

jirimaier commented May 6, 2024 •

edited

jirimaier commented May 6, 2024

lordfolken May 8, 2024

lordfolken May 8, 2024

lordfolken commented May 8, 2024

xtophe80 commented May 8, 2024

Dialog for setting user-defined frequencies #1417

Are you sure you want to change the base?

Dialog for setting user-defined frequencies #1417

Conversation

jirimaier commented Apr 30, 2024 • edited

lordfolken commented Apr 30, 2024

DanD222 commented Apr 30, 2024 • edited

jirimaier commented Apr 30, 2024

lordfolken commented Apr 30, 2024

lordfolken commented Apr 30, 2024

DanD222 commented Apr 30, 2024 • edited

kobedegeest commented Apr 30, 2024

jirimaier commented Apr 30, 2024

lordfolken left a comment

Choose a reason for hiding this comment

lordfolken commented May 5, 2024

lordfolken May 5, 2024

Choose a reason for hiding this comment

lordfolken May 5, 2024

Choose a reason for hiding this comment

lordfolken commented May 5, 2024

lordfolken commented May 6, 2024 • edited

jirimaier commented May 6, 2024 • edited

jirimaier commented May 6, 2024

lordfolken May 8, 2024

Choose a reason for hiding this comment

lordfolken May 8, 2024

Choose a reason for hiding this comment

lordfolken commented May 8, 2024

xtophe80 commented May 8, 2024

jirimaier commented Apr 30, 2024 •

edited

DanD222 commented Apr 30, 2024 •

edited

DanD222 commented Apr 30, 2024 •

edited

lordfolken commented May 6, 2024 •

edited

jirimaier commented May 6, 2024 •

edited