... | ... |
@@ -21,20 +21,19 @@ also handle formatting of CAT commands and their associated parameters, |
21 | 21 |
while 'get' functions handle parsing of data returned from CAT commands |
22 | 22 |
that return status information. |
23 | 23 |
|
24 |
+Email bug reports and comments to: fractal@intravisions.com |
|
25 |
+ |
|
24 | 26 |
Notes |
25 | 27 |
----- |
26 | 28 |
1. The files ft991utility.py and ft991.py should be downloaded from the |
27 |
- github repository and placed in the same folder. At the root level |
|
28 |
- of the fractalxoas/ham repository, click on 'Clone or download'. |
|
29 |
- Experienced github users may choose to clone the repository, otherwise |
|
30 |
- select 'Download ZIP'. |
|
29 |
+ github repository and placed in the same folder. |
|
31 | 30 |
2. To run the utility, open a terminal session in directory containing |
32 | 31 |
the ft991utility.py and ft991.py files. Then simply type the utility |
33 | 32 |
file name after the command line prompt, e.g., |
34 | 33 |
~$ ./ft991utility.py |
35 | 34 |
If necessary, change the permissions on ft991utility.py to allow the file |
36 | 35 |
to be run as an executable. To change the permissions run the command |
37 |
- chmod +x ft991utility.py2. |
|
36 |
+ chmod +x ft991utility.py |
|
38 | 37 |
3. Windows users will need to have the python 2.7 framework installed. |
39 | 38 |
Probably, the easiest way to get the framework is to install the |
40 | 39 |
Windows Subsystem for Linux Ubuntu platform. Note that the utility |
... | ... |
@@ -45,7 +44,7 @@ Notes |
45 | 44 |
name of the utility with no command line arguments, e.g., |
46 | 45 |
./ft991utility.py |
47 | 46 |
5. The utility saves memory settings in a comma-delimited file that |
48 |
- can be imported using a spreadsheet application for ease in viewing |
|
47 |
+ can be imported into a spreadsheet application for ease in viewing |
|
49 | 48 |
and editing. A LibreOffice Calc template 'ft991_memory_settings.ots' |
50 | 49 |
has been provided to facilitate creating a spreadsheet to upload memory |
51 | 50 |
settings to the FT991. |
... | ... |
@@ -58,13 +57,13 @@ Notes |
58 | 57 |
to back up your current memory settings. Unless you change the default |
59 | 58 |
file name, this file should appear in your current working directory as |
60 | 59 |
'ft991mem.csv'. Change this file name to something else such as |
61 |
- 'ft991mem_todaysDate.csv' so that you can restore from this file at a |
|
60 |
+ 'ft991mem_todaysDate.csv so that you can restore from this file at a |
|
62 | 61 |
later date if necessary. |
63 | 62 |
8. By the same token you should immediately back up your menu settings using |
64 | 63 |
the 'bu' command in interactive mode. The default file name is |
65 | 64 |
'ft991menu.cfg'. Likewise change this file name to something else. |
66 | 65 |
9. The example file 'example.csv' shows how a memory settings file should |
67 |
- appear. To load these settings into your FT991, run the 'rm' command in |
|
66 |
+ appear. To load these settings in your FT991, run the 'rm' command in |
|
68 | 67 |
interactive mode. When prompted to enter a file name type 'example.csv'. |
69 | 68 |
For example, |
70 | 69 |
Enter file name or <CR> for default: example.csv |
... | ... |
@@ -75,5 +74,4 @@ Notes |
75 | 74 |
what you are doing. There should rarely be a need to edit this file. |
76 | 75 |
Menu changes should be made on the FT991, itself, and then backed up. |
77 | 76 |
|
78 |
-Email bug reports and comments to: fractal@intravisions.com |
|
79 | 77 |
|
... | ... |
@@ -24,7 +24,10 @@ that return status information. |
24 | 24 |
Notes |
25 | 25 |
----- |
26 | 26 |
1. The files ft991utility.py and ft991.py should be downloaded from the |
27 |
- github repository and placed in the same folder. |
|
27 |
+ github repository and placed in the same folder. At the root level |
|
28 |
+ of the fractalxoas/ham repository, click on 'Clone or download'. |
|
29 |
+ Experienced github users may choose to clone the repository, otherwise |
|
30 |
+ select 'Download ZIP'. |
|
28 | 31 |
2. To run the utility, open a terminal session in directory containing |
29 | 32 |
the ft991utility.py and ft991.py files. Then simply type the utility |
30 | 33 |
file name after the command line prompt, e.g., |
1 | 1 |
new file mode 100644 |
... | ... |
@@ -0,0 +1,76 @@ |
1 |
+Module: ft991utility.py |
|
2 |
+ |
|
3 |
+Introduction |
|
4 |
+------------ |
|
5 |
+The ft991 utility is an interactive tool for backing up and restoring both |
|
6 |
+the memory settings and menu settings of the Yaesu FT991 transceiver. |
|
7 |
+Individual memory locations store information about frequency, repeater |
|
8 |
+offset, signaling, tags, modulation, and clarifier. Menu settings store |
|
9 |
+configuration information about current menu options and parameters. The |
|
10 |
+utility also has a pass through mode for sending CAT commands directly to |
|
11 |
+the transceiver. This feature is useful for future code development and |
|
12 |
+debugging. |
|
13 |
+ |
|
14 |
+The ft991.py module encapsulates the FT991 CAT commands and handles low |
|
15 |
+level serial communication to and from the FT991 usb port. CAT commands |
|
16 |
+are encapsulated according to object oriented methodology, that is, 'set' |
|
17 |
+to send parameters and settings to the FT991, and 'get' to receive status |
|
18 |
+information back from the FT991. Additionally ft991.py contains helper |
|
19 |
+functions for parsing data read from backup files. The 'set' functions |
|
20 |
+also handle formatting of CAT commands and their associated parameters, |
|
21 |
+while 'get' functions handle parsing of data returned from CAT commands |
|
22 |
+that return status information. |
|
23 |
+ |
|
24 |
+Notes |
|
25 |
+----- |
|
26 |
+1. The files ft991utility.py and ft991.py should be downloaded from the |
|
27 |
+ github repository and placed in the same folder. |
|
28 |
+2. To run the utility, open a terminal session in directory containing |
|
29 |
+ the ft991utility.py and ft991.py files. Then simply type the utility |
|
30 |
+ file name after the command line prompt, e.g., |
|
31 |
+ ~$ ./ft991utility.py |
|
32 |
+ If necessary, change the permissions on ft991utility.py to allow the file |
|
33 |
+ to be run as an executable. To change the permissions run the command |
|
34 |
+ chmod +x ft991utility.py2. |
|
35 |
+3. Windows users will need to have the python 2.7 framework installed. |
|
36 |
+ Probably, the easiest way to get the framework is to install the |
|
37 |
+ Windows Subsystem for Linux Ubuntu platform. Note that the utility |
|
38 |
+ has not been tested on Windows and the developer makes no guarentees. |
|
39 |
+4. While it is possible to run the utility completely from the command |
|
40 |
+ line using options, beginning users are encouraged to use the |
|
41 |
+ interactive mode. To use the interactive mode simply type the file |
|
42 |
+ name of the utility with no command line arguments, e.g., |
|
43 |
+ ./ft991utility.py |
|
44 |
+5. The utility saves memory settings in a comma-delimited file that |
|
45 |
+ can be imported using a spreadsheet application for ease in viewing |
|
46 |
+ and editing. A LibreOffice Calc template 'ft991_memory_settings.ots' |
|
47 |
+ has been provided to facilitate creating a spreadsheet to upload memory |
|
48 |
+ settings to the FT991. |
|
49 |
+6. The verbose mode, available both as a command line option and in |
|
50 |
+ interactive mode, echos raw commands sent to the FT991, as well as |
|
51 |
+ raw status returned by the FT991. This feature is useful for development |
|
52 |
+ and debugging purposes. |
|
53 |
+7. If you already have repeater frequencies and such programmed |
|
54 |
+ in memory, you should first run the 'bm' command in interactive mode |
|
55 |
+ to back up your current memory settings. Unless you change the default |
|
56 |
+ file name, this file should appear in your current working directory as |
|
57 |
+ 'ft991mem.csv'. Change this file name to something else such as |
|
58 |
+ 'ft991mem_todaysDate.csv' so that you can restore from this file at a |
|
59 |
+ later date if necessary. |
|
60 |
+8. By the same token you should immediately back up your menu settings using |
|
61 |
+ the 'bu' command in interactive mode. The default file name is |
|
62 |
+ 'ft991menu.cfg'. Likewise change this file name to something else. |
|
63 |
+9. The example file 'example.csv' shows how a memory settings file should |
|
64 |
+ appear. To load these settings into your FT991, run the 'rm' command in |
|
65 |
+ interactive mode. When prompted to enter a file name type 'example.csv'. |
|
66 |
+ For example, |
|
67 |
+ Enter file name or <CR> for default: example.csv |
|
68 |
+10. Backup and restore of split frequency memory settings is not yet implemented. |
|
69 |
+ The 'Tx Frequency' and 'Offset' columns in the memory settings file should |
|
70 |
+ be left blank. |
|
71 |
+11. Please do not edit the menu settings file unless you absolutely know |
|
72 |
+ what you are doing. There should rarely be a need to edit this file. |
|
73 |
+ Menu changes should be made on the FT991, itself, and then backed up. |
|
74 |
+ |
|
75 |
+Email bug reports and comments to: fractal@intravisions.com |
|
76 |
+ |