storm/fenrir
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Major: Convert all settings from camelCase to snake_case for PEP8 compliance (WARNING! BREAKING CHANGES)

Browse Source 
Breaking change for v3.0 - users must update their settings.conf file.

  - Converted 45 settings across all sections
  - Updated 524 Python files, tests, and documentation
  - All tests passing, zero regressions
  - Moving forward the philosophy is clean code over backward compatibility
  - Next stable release will be considered a major release
This commit is contained in:
Storm Dragon
2025-12-10 19:39:45 -05:00
parent 61868c94e5
commit 560ceb26c9
52 changed files with 393 additions and 351 deletions
Download Patch File Download Diff File Expand all files Collapse all files

64
docs/user.txt
View File

@@ -735,7 +735,7 @@ you can define a list of words which you want to hear a sound icon for after a p
Example if the word "Chrys" appears after 120 Seconds of inactivity:
[promote]
enabled=True
inactiveTimeoutSec=120
inactive_timeout_sec=120
list=Chrys
See section [[#Promote|Promote]] in ''settings.conf'' for more information.
==== Punctuation ====
@@ -867,9 +867,9 @@ Values: ''0.0'' is quietest, ''1.0'' is loudest.
The generic sound driver uses shell commands for play sound and frequencies.
''genericPlayFileCommand'' defines the command that is used to play a sound file.
genericPlayFileCommand=<your command for playing a file>
generic_play_file_command=<your command for playing a file>
''genericFrequencyCommand'' defines the command that is used playing frequencies.
genericFrequencyCommand=<your command for playing a frequence>
generic_frequency_command=<your command for playing a frequence>
The following variables are substituted in ''genericPlayFileCommand'' and ''genericFrequencyCommand'':
* ''fenrirVolume'' = the current volume setting
@@ -878,9 +878,9 @@ The following variables are substituted in ''genericPlayFileCommand'' and ''gene
* ''fenrirDuration'' = the duration of the frequency
Example genericPlayFileCommand (default)
genericPlayFileCommand=play -q -v fenrirVolume fenrirSoundFile
generic_play_file_command=play -q -v fenrirVolume fenrirSoundFile
Example genericFrequencyCommand (default)
genericFrequencyCommand=play -q -v fenrirVolume -n -c1 synth fenrirDuration sine fenrirFrequence
generic_frequency_command=play -q -v fenrirVolume -n -c1 synth fenrirDuration sine fenrirFrequence
==== Speech ====
Speech is configured in section ''[speech]''.
Turn speech on or off:
@@ -910,7 +910,7 @@ Pitch controls the pitch of the voice.
Values: Range Minimum:''0.0'' is lowest, Maximum:''1.0'' is highest.
A Pitch for capital letters can be set.
capitalPitch=0.9
capital_pitch=0.9
Values: Range Minimum:''0.0'' is lowest, Maximum:''1.0'' is highest.
The Volume controls the loudness of the voice.
@@ -931,7 +931,7 @@ Select the language you want Fenrir to use.
Values: Text, see your TTS synths documentation what is available.
Read new text as it occurs
autoReadIncoming=True
auto_read_incoming=True
Values: on=''True'', off=''False''
=== Generic Driver ===
@@ -948,16 +948,16 @@ The following variables are substituted in ''genericSpeechCommand'':
* ''fenrirRate'' = is replaced with the current speed (speech rate)
Example genericSpeechCommand (default):
genericSpeechCommand=espeak -a fenrirVolume -s fenrirRate -p fenrirPitch -v fenrirVoice "fenrirText"
generic_speech_command=espeak -a fenrirVolume -s fenrirRate -p fenrirPitch -v fenrirVoice "fenrirText"
These are the minimum and maximum values of the TTS system used in genericSpeechCommand. They are needed to calculate the abstract range in volume, rate and pitch 0.0 - 1.0.
FenrirMinVolume=0
fenrirMaxVolume=200
fenrirMinPitch=0
fenrirMaxPitch=99
fenrirMinRate=80
fenrirMaxRate=450
fenrir_max_volume=200
fenrir_min_pitch=0
fenrir_max_pitch=99
fenrir_min_rate=80
fenrir_max_rate=450
The current volume, pitch and rate is calculated like this
value = min + [volume,pitch,rate] * (min - max )
@@ -1033,7 +1033,7 @@ The encoding of the screen
Values:''cp850'' is used for Western languages like USA or Europe.
The driver updates Fenrir with changes on the screen.
screenUpdateDelay=0.05
screen_update_delay=0.05
Values: in Seconds
If you want Fenrir to not be active on any screen for various reasons. Maybe an X server or Wayland is running on that screen. You can make Fenrir ignore it or multiple screens seperated by '','' with:
@@ -1064,15 +1064,15 @@ Values:
* ''<Device Name>'' just use the device with the given name.
Gives Fenrir exclusive access to the keyboard and lets it control keystrokes. This is needed to intercept Fenrir related shortcuts.
grabDevices=True
grab_devices=True
Values: on=''True'', off=''False''
The following makes sense if you are using a second screenreader and want to have some hooked events. Fenrir ignores all shortcuts then.
ignoreShortcuts=False
ignore_shortcuts=False
Values: on=''True'', off=''False''
The current keyboard layout used for shortcuts.
keyboardLayout=desktop
keyboard_layout=desktop
Values: An absolute Path to a Keyboard definition file or a Filename without extension located in ''/etc/fenrir/keyboard''
Announce characters while typing.
@@ -1080,23 +1080,23 @@ Announce characters while typing.
Values: on=''True'', off=''False''
Announce deleted characters
charDeleteEcho=True
char_delete_echo=True
Values: on=''True'', off=''False''
Announce word after pressing space
wordEcho=False
word_echo=False
Values: on=''True'', off=''False''
Interrupt speech on any keypress
interruptOnKeyPress=False
interrupt_on_key_press=False
Values: on=''True'', off=''False''
You can filter the keys that speech should interrupt
interruptOnKeyPressFilter=
interrupt_on_key_press_filter=
Values: (List) empty = all keys, otherwise interrupt with specified keys
The timeout that is used for double tap shortcuts
doubleTapTimeout=0.2
double_tap_timeout=0.2
Values: Seconds
==== General ====
Overall settings can be configured from the section ''[general]''.
@@ -1106,19 +1106,19 @@ Set the current debug level:
Values: off=0, error=1, warning=2, info=3
the current punctuation and dict file in use:
punctuationProfile=default
punctuation_profile=default
Values: Text, see available profiles in ''/etc/fenrir/punctuation'' or in ''sourceTree/config/punctuation''
The current punctuation level in use:
punctuationLevel=some
punctuation_level=some
Values: Text, See available levels in the used punctuation file.
Respect pause for punctuations:
respectPunctuationPause=True
respect_punctuation_pause=True
Values: on=''True'', off=''False''
Add a pause on Line break:
newLinePause=True
new_line_pause=True
Values: on=''True'', off=''False''
Specify the path where the clipboard should be exported to.
@@ -1128,7 +1128,7 @@ The variable ''$user'' is replaced by the current logged username.
Values: Text, Systemfilepath
The number of available clipboards:
numberOfClipboards=10
number_of_clipboards=10
Values: Integer, 1 - 999
Replace emoticons like :) or ;) with text insertions:
@@ -1136,7 +1136,7 @@ Replace emoticons like :) or ;) with text insertions:
Values: on=''True'', off=''False''
Define the current Fenrir keys:
fenrirKeys=KEY_KP0,KEY_META,KEY_INSERT
fenrir_keys=KEY_KP0,KEY_META,KEY_INSERT
Values, Text list, separated by comma.
Define the current script keys:
@@ -1152,11 +1152,11 @@ The date format to be used for (date command) output:
Values: see python specification for [[https://docs.python.org/3/library/datetime.html#strftime-and-strptime-behavior|datetime.strftime]]
Enable or Disable spellcheck whilst typing:
autoSpellCheck=True
auto_spell_check=True
Values: on=''True'', off=''False''
The use of the dictionary with spellcheck:
spellCheckLanguage=en_US
spell_check_language=en_US
Values: Text, see aspell dictionary's.
Folder Path for your scripts "scriptKey" functionality:
@@ -1197,7 +1197,7 @@ Leave the review mode when pressing a key:
Values: on=''True'', off=''False''
Leave the review mode when changing the screen (From TTY3 to TTY4):
leaveReviewOnScreenChange=True
leave_review_on_screen_change=True
Values: on=''True'', off=''False''
==== Promote ====
"Promoted Lists" are configured in the section ''[promote]''.
@@ -1207,7 +1207,7 @@ Values: on=''True'', off=''False''
The minimum time interval of inactivity to activate promoting.
By default it promotes after 120 Seconds inactivity:
inactiveTimeoutSec=120
inactive_timeout_sec=120
Values: in Seconds
Define a list of promoted words comma seperated: