Fix ~ not expanded

CHANGELOG.rst

@@ -2,9 +2,78 @@
 srt-py Change Log
 =================
 
-.. current developments
 
-vv1.1.1
+**Current developments:**
+
+**Added:**
+
+* ``DASHBOARD_THREADS``, ``NPOINT_INTEG_TIME``, ``MINIMAL_ARROWS_DISTANCE``, ``PLAY_SOUNDS``, ``NPOINT_ARROWS``, ``SPECTRUM_HISTORY_LENGTH``, ``WATERFALL_LENGTH``, ``GUI_TIMEZONE``, ``DISPLAY_LIM``, ``DRAW_ECLIPTIC``, ``DRAW_EQUATOR``, ``N_PNT_COUNT``, ``BSWITCH_INTEG_TIME``, ``GOTO_STOW_AT_STARTUP`` parameters
+* CASSI motor support
+* Baudrate check for H180 and CASSI motors classes
+* Non-physical limit warning
+* Windrose letters and lines in Azimuth and Elevation Graph
+* Buttons to modebar: all shape drawing,  ``togglespikelines`` and ``togglehover``
+* Drawing of n-point scan points on az-el graph
+* Drawing arrows showing motor route
+* ``playsound`` command
+* Optional sound when n-point scan and beam switch are complete
+* ``rot_curve.txt`` command file
+* ``ocl-icd-system`` to the recipe to avoid https://github.com/MITHaystack/srt-py/issues/21#issuecomment-1963827916
+* ``tzlocal`` to recipe
+* Optional arrows showing route of n-point scan
+* ``azel_to_coords.py``, ``coords_to_azel.py``
+* Recording indicator to system page
+* Waterfall spectrum plot
+* Spectrum history length to parameter
+* User now can choose timezone in Monitor Page
+* Az-el graph display limits to parameter
+* Optional drawing of ecliptic and equator planes
+* Real size Sun and Moon shapes
+* Logging messages to beam switch
+* Warning message when angle out of bounds during n-point scan and beam switch
+* Log message at the end of n-point scan and beam switch
+* Beam switch graph
+* Option to automatically go to STOW at startup
+
+**Changed:**
+
+* Remember zoom after refresh in Azimuth and Elevation Graph
+* Hide Plotly logo
+* Enabe scroll zoom
+* ``monitor_page.png``
+* fk4 to icrs in ``sky_coords.csv``
+* Sort the system page by newest issue first
+* Different marker types on az el graph
+* Marker for visability to circular
+* Number of n-point scan rotor positions to parameter
+* Height of n-point scan graph to 300
+* N-point scan and beam switch integration times to parameters
+
+**Fixed:**
+
+* Searching for default config dir (https://github.com/MITHaystack/srt-py/issues/23)
+* Astropy deprecations
+* H180 class: init (https://github.com/MITHaystack/srt-py/issues/21) and updating ``self.az_count``, ``self.el_count`` (https://github.com/MITHaystack/srt-py/issues/24)
+* N-point scan and beam switch numbering (off-by-one error)
+* Conda build error (https://github.com/MITHaystack/srt-py/issues/19)
+* N-point scan and beam switch center not updated during scan (https://github.com/MITHaystack/srt-py/issues/25)
+* Visability rectangle for negative STOW azimuth (overwritten by: marker for visability to circular)
+* Dash deprecation: ``className`` to ``class_name`` (https://github.com/AlexKurek/srt-py/commit/43946aa7e8453154096ddc45c092f506cda00cff)
+* ``utcfromtimestamp`` deprecation
+* Comment unused modules in ``srt/daemon/radio_control/`` (https://github.com/AlexKurek/srt-py/commit/9a3f9d05a5b0fd2e2b8300441605010e2586599c)
+* Graphs appear faster
+* Beam switch count (off-by-one error)
+
+**Known issues:**
+
+* A lot of waitress logging messages is printed (https://github.com/MITHaystack/srt-py/issues/27)
+* Beam-switch and N-Point Scan not possible after Direct Point to the same object (https://github.com/MITHaystack/srt-py/issues/29)
+* Versioneer is outdated and not supporting current Python versions
+* GOTO_STOW_AT_STARTUP not working
+
+
+
+v1.1.1
 ====================
 
 **Added:**
@@ -14,7 +83,7 @@ vv1.1.1
 
 
 
-vv1.1.0
+v1.1.0
 ====================
 
 **Added:**

README.md

@@ -20,18 +20,80 @@ This software is written in pure Python, and so depends on having an installed v
 
 ### Building the Conda Package Locally
 
-After downloading the srt-py source repository, open up a command prompt or terminal with conda installed and navigate to the folder containing the srt-py directory.  Additionally, ensure that you have conda-build and conda-verify installed
+Download srt-py source repository using command prompt or terminal with conda installed:
+```
+conda update -y --all
+git clone https://github.com/AlexKurek/srt-py
+```
+
+Ensure that you have `conda-build` and `conda-verify` installed
+
+```
+conda install -y conda-build conda-verify
+```
+
+Build the conda package
+
+```
+conda build -c conda-forge srt-py --no-test --no-anaconda-upload
+```
+
+Create a new conda env, switch it to the conda-forge channel and activate it
 
 ```
-conda install conda-build conda-verify
+conda create -y -n srtpy
+conda activate srtpy
+conda config --env --add channels conda-forge
+conda config --env --set channel_priority strict
 ```
 
-Build and install the conda package
+Install the package
 
 ```
-conda-build srt-py
-conda install -c file://${CONDA_PREFIX}/conda-bld/ srt-py
+conda install -y --use-local srt-py
+```
+
+Copy config files and an exemplary command file to your HOME:
+
+```
+mkdir ~/.srtpy-config/
+cp -r ~/srt-py/config/{config.yaml,schema.yaml,sky_coords.csv} ~/.srtpy-config/
+cp ~/srt-py/examples/example_cmd_file.txt ~/
+rm -rf ~/srt-py/
+```
+
+Enable udev device setup of rtl-sdr hardware
+
 ```
+sudo ln -s ~/miniconda3/envs/srtpy/lib/udev/rules.d/rtl-sdr.rules /etc/udev/rules.d/
+```
+
+Reload your udev rules
+
+```
+sudo udevadm control --reload && sudo udevadm trigger
+```
+
+Cleanup
+
+```
+conda deactivate
+conda build purge
+```
+
+If you have Ubuntu 22 and getting https://askubuntu.com/questions/1403705/dev-ttyusb0-not-present-in-ubuntu-22-04
+
+```
+sudo apt purge brltty
+sudo rm -rv /var/lib/BrlAPI/
+```
+
+If you are getting `Cannot open /dev/ttyUSB0: Permission denied`
+```
+sudo usermod -a -G tty,dialout $USER
+```
+
+Do a proper logout or reboot.
 
 ### Building the Pip Package Locally (Not Recommended due to Dependency Issues)
 
@@ -104,14 +166,14 @@ The bar at the top of the dashboard manages sending commands to the SRT, which a
 
 Additionally, there are four different interactive graphs displayed on this screen.
 The 'Power vs Time' graph displays the received power over a certain range of time into the past.
-The first of the two spectrum graphs, 'Raw Spectrum', shows the processed and integrated radio FFT data, whose values don't necessarily have any real world units and have a shape that is influenced by the band-pass filter.  The other, 'Calibrated Spectrum' shows the values after dividing out the calibration values taken when the 'Calibrate' command was last run on a test source of known temperature (such as a clump of trees or a noise diode).
-Finally, there is the Azimuth-Elevation graph, which shows the current position of all objects specified to be tracked in the sky_coords.csv configuration file, as well as the reachable limits of the motor and the horizon.  Clicking on a point allows you to send a command to track that object, perform an n-point scan about the object, or repeatedly move the antenna across it.
+The first of the two spectrum graphs, 'Raw Spectrum', shows the processed and integrated radio FFT data, whose values don't necessarily have any real world units and have a shape that is influenced by the band-pass filter. The other, 'Calibrated Spectrum', shows the values after dividing out the calibration values taken when the 'Calibrate' command was last run on a test source of known temperature (such as a clump of trees or a noise diode). 'Raw Spectrum History' shows a waterfall plot sometimes called also a dynamic spectrum.
+Finally, there is the Azimuth-Elevation graph, which shows the current position of all objects specified to be tracked in the sky_coords.csv configuration file, as well as the reachable limits of the motor and the horizon. Clicking on a point allows you to send a command to track that object, perform an n-point scan about the object, or repeatedly move the antenna across it.
 
 #### System Page UI
 
 ![System Page](docs/images/system_page.png)
 
-The System Page contains many displays of information not necessary for actively controlling the SRT.  In case of a serious problem occuring when operating the SRT, there is a section for Emergency Contact Info.  There is similarly a 'Message Logs' scrolling area for logs sent from the SRT, in order to assist in debugging or just determining what it has done recently.  In the middle is a more verbose status blurb about the status of the SRT's command queue, including the number of commands queued up and what the SRT is currently trying to run.  Finally, there is also a list of the files and folders in the SRT's specified recording save directory, which users can directly download files from via the dashboard if the "DASHBOARD_DOWNLOADS" setting in the configuration YAML is set to Yes.
+The System Page contains many displays of information not necessary for actively controlling the SRT.  In case of a serious problem occuring when operating the SRT, there is a section for Emergency Contact Info.  There is similarly a 'Message Logs' scrolling area for logs sent from the SRT, in order to assist in debugging or just determining what it has done recently.  In the middle is a more verbose status blurb about the status of the SRT's command queue, including the number of commands queued up and what the SRT is currently trying to run. Finally, there is also a list of the files and folders in the SRT's specified recording save directory, which users can directly download files from via the dashboard if the "DASHBOARD_DOWNLOADS" setting in the configuration YAML is set to Yes.
 
 ### Running Headless / Command Line Usage
 
@@ -164,6 +226,8 @@ srt_controller.py status --status_parameter=motor_azel
 - plotly
 - pandas
 - waitress
+- ocl-icd-system
+- tzlocal
 
 ## Accommodating Different Hardware
 
@@ -187,9 +251,10 @@ Adding a new antenna motor therefore requires:
 - Making the string name for that motor create that motor in  [rotors.py](srt/daemon/rotor_control/rotors.py)
 - Adding the string name as an valid option in the [YAML schema](config/schema.yaml) MOTOR_TYPE so the new type will be considered valid, such as:
 ```
-MOTOR_TYPE: enum('ALFASPID', 'H180MOUNT', 'PUSHROD', 'NONE')
+MOTOR_TYPE: enum('ALFASPID', 'H180MOUNT', 'PUSHROD', 'NONE', 'CASSI')
 ```
 - Changing the MOTOR_TYPE in your own configuration YAML to the new motor type
+- Adding the string name to the condition in `generate_az_el_graph` method in [graphs.py](https://github.com/AlexKurek/srt-py/blob/master/srt/dashboard/layouts/graphs.py).
 
 ## Further Documentation
 

bin/srt_runner.py

@@ -11,6 +11,7 @@
 
 from waitress import serve
 from srt import config_loader
+from os.path import expanduser
 
 
 def run_srt_daemon(configuration_dir, configuration_dict):
@@ -28,6 +29,7 @@ def run_srt_dashboard(configuration_dir, configuration_dict):
         app_server,
         host=configuration_dict["DASHBOARD_HOST"],
         port=configuration_dict["DASHBOARD_PORT"],
+        threads=configuration_dict["DASHBOARD_THREADS"],
     )
 
 
@@ -41,7 +43,7 @@ def run_srt_dashboard(configuration_dir, configuration_dict):
         metavar="config_dir",
         type=str,
         help="The Path to the SRT Config Directory",
-        default="~/.srt-config",
+        default=expanduser("~/.srt-config"),
     )
     my_parser.add_argument(
         "--config_file_name",
@@ -50,13 +52,11 @@ def run_srt_dashboard(configuration_dir, configuration_dict):
         help="The filename of the Config File to Load",
         default="config.yaml",
     )
-
     my_parser.add_argument(
         "--dash_only",
         dest="dash_only",
         action="store_true",
         help="Load up the dashboard only",
-
     )
     # Execute the parse_args() method
     args = my_parser.parse_args()

config/config.yaml

@@ -41,8 +41,26 @@ BEAMWIDTH: 7.0
 TSYS: 171
 TCAL: 290
 SAVE_DIRECTORY: ~/Desktop/SRT-Saves
+NPOINT_INTEG_TIME: 5.0
+BSWITCH_INTEG_TIME: 5.0
+MINIMAL_ARROWS_DISTANCE: 5.0
 RUN_HEADLESS: No
 DASHBOARD_PORT: 8080
 DASHBOARD_HOST: 0.0.0.0
 DASHBOARD_DOWNLOADS: Yes
 DASHBOARD_REFRESH_MS: 3000
+DASHBOARD_THREADS: 8
+PLAY_SOUNDS: Yes
+NPOINT_ARROWS: Yes
+SPECTRUM_HISTORY_LENGTH: 1000
+WATERFALL_LENGTH: 200
+GUI_TIMEZONE: UTC
+DISPLAY_LIM:
+  az_lower_display_lim: 0
+  az_upper_display_lim: 360
+  el_lower_display_lim: 0
+  el_upper_display_lim: 90
+DRAW_ECLIPTIC: Yes
+DRAW_EQUATOR: Yes
+N_PNT_COUNT: 25
+GOTO_STOW_AT_STARTUP: Yes

config/schema.yaml

@@ -5,7 +5,7 @@ ELLIMITS: include('limit')
 STOW_LOCATION: include('az_el_point')
 CAL_LOCATION: include('az_el_point')
 HORIZON_POINTS: list(include('az_el_point'), min=0)
-MOTOR_TYPE: enum('ALFASPID', 'H180MOUNT', 'PUSHROD', 'NONE')
+MOTOR_TYPE: enum('ALFASPID', 'H180MOUNT', 'PUSHROD', 'NONE', 'CASSI')
 MOTOR_BAUDRATE: int()
 MOTOR_PORT: str()
 RADIO_CF: int()
@@ -19,11 +19,25 @@ BEAMWIDTH: num()
 TSYS: num()
 TCAL: num()
 SAVE_DIRECTORY: str()
+NPOINT_INTEG_TIME: num()
+BSWITCH_INTEG_TIME: num()
+MINIMAL_ARROWS_DISTANCE: num()
 RUN_HEADLESS: bool()
 DASHBOARD_PORT: int()
 DASHBOARD_HOST: ip()
 DASHBOARD_DOWNLOADS: bool()
 DASHBOARD_REFRESH_MS: int()
+DASHBOARD_THREADS: int()
+PLAY_SOUNDS: bool()
+NPOINT_ARROWS: bool()
+SPECTRUM_HISTORY_LENGTH: int()
+WATERFALL_LENGTH: int()
+GUI_TIMEZONE: str()
+DISPLAY_LIM: include('disp_limit')
+DRAW_ECLIPTIC: bool()
+DRAW_EQUATOR: bool()
+N_PNT_COUNT: int()
+GOTO_STOW_AT_STARTUP: bool()
 ---
 location:
     latitude: num()
@@ -42,3 +56,8 @@ contact_info:
     name: str()
     email: str()
     phone_number: str()
+disp_limit:
+    az_lower_display_lim: num()
+    az_upper_display_lim: num()
+    el_lower_display_lim: num()
+    el_upper_display_lim: num()