Configuration file


Summary

The configuration file is where the API key and download location inputted during installation gets saved. It also has a couple other settings as well.

Location

On Windows, the configuration file can be found here:
C:\Program Files (x86)\Cirrus Forecast\Cirrus Forecast Downloader\config\settings.ini

Example file

Here is an example of what the settings.ini file contains.

[General]
LibraryVersion=1.0.0

[Settings]
ApiKey=a0123456789z_abcdefghijklmnopqrstuvwxyz
DownloadDirectory=C:\Users\automation\Desktop\cirrus_forecast_files

[Logging]
Level=normal

Configuration options

Category Option Description
General LibraryVersion This is the current version of the Cirrus Forecast Downloader you are running.

Note: This is for informational purposes and shouldn't be changed.
Settings ApiKey Your API key from the "My Profile" page
Settings DownloadDirectory The directory to download the weather forecast audio files.
Logging Level This is how detailed the logs that the Cirrus Forecast Downloader creates should be.

It can either be normal (default value) or debug.

Updating configuration

If you need to update your API key or the download path, you can change it in the configuration file and re-save it. After re-saving it, you will need to restart the Windows Service so it picks up the changes.

The ApiKey can be found on the "My Profile" page here. To get a new API key, click "Generate new API key".

{warning} Generating a new API key overwrites the old one. If you already have the downloader running, it will stop working until the API key is updated with the newly generated one.

Note: In order to keep your API key secure, you cannot retrieve a previously generated API key once you leave the "My Profile" page after generating a new one. You can, however, re-generate a key as many times as you need to. Because of this, it is advised to NOT record or write the key somewhere other than this configuration file.

To edit the file, right-click on it and click "Edit". This will open Notepad. Once the changes are made, go to File -> Save.

{info} If you get an error trying to save the settings.ini file or a "Save as..." window comes up, you don't have permission to edit the file. To get around this, copy the file to your Desktop, make the changes, and then drag-and-drop the file back to C:\Program Files (x86)\Cirrus Forecast\Cirrus Forecast Downloader\config\

Steps to restart the Windows Service

  1. Search for services or services.msc in the Start Menu and open
  2. Find "Cirrus Forecast Downloader" in the list and click on it to select it
  3. Click "Restart" on the top left