Skip to content

Latest commit

 

History

History
61 lines (41 loc) · 3.78 KB

README.md

File metadata and controls

61 lines (41 loc) · 3.78 KB
Raw

MorsecodeGUI

a morse code gui made for a scout thing

Designed to run on a raspberry pi, unknown screen size so everything is just based on fractions of the screen and an assumed standard aspect ratio of 16:9 (although it has been tested on everything from 3:4(standard, looks a little dodgy) to 21:9 (ultrawide))

Here's it running in demo mode (after having been left idle for x amount of time)

morsedemo

Features currently in there:

  • On screen keyboard and morse code key
  • On screen visualisation of current morse code
  • Translation of code into english
  • Physical mouse/keyboard integration
  • Physical morse code key integration (on Raspberry Pi only)
  • Sound when the on screen, physical, or keyboard key is pressed
  • A demo mode that types out predetermined words after x amount of idle time
  • Error handling for both user modification of config.py and during runtime
  • A clear button to remove all text from the screen
  • An on screen way to mute the sounds
  • Playback to hear what you've typed

Features still to add:

  • Auto-update (a call to check this repo on start to check that it's the latest version)

How To:

Run the program:

Start 'morse-main.py' with your favourite way of running python 3. It'll tell you if it's missing any libraries. It shouldn't be missing anything if it's running on Raspbian, on a Raspberry Pi.

Set up the physical morse code key to a Raspberry Pi:

Two resistors and a few wires will be needed to connect the morse code key to the Raspberry Pi. By default the program is expecting the key to be plugged into a specific pin, although if you know what you're doing feel free to change gpiokey to your liking. The wiring goes a little like this:

raspberrywiring

If you know how to deal with circuit diagrams drawn in paint then yay you're all set. If you're not then go and get an adult to help you set things up. In case you can't tell the key is represented by the switch in the diagram.

Close the program:

There's a word called exitword in 'config.py'. Type it to close the program. If you don't want it to be the default of quit (because people might type it accidentally), feel free to change it to something else.

Hitting escape also closes the program if the escapetoclose value in 'config.py' is True. Set it to False (case sensitive) to disable

Change the colours:

All colours are represented in the 'config.py' file, inside parentheses with an rgb format, and look like this: (126,255,0) Each number represents the red, green, and blue values of a colour in that order, and can be any number in the range from 0 to 255 (inclusive).

For example, (255,0,0) would be pure red, as the red value is at its maximum, and blue and green are at their minimum. Feel free to change any colours you see like that to make it look as pretty as you want.

Change the demo behaviour

There's a list of words called demowords in 'config.py' that are randomly chosen to type out by the program in demo mode. Feel free to add/subtract your own words to this list to make it fit the theme of what you're going for.

Just ensure that all words are inside quotations "like this" or 'like this' but not 'like this" "or this'

There's also a number right next todemowords called demotime, which is simply the number of seconds that the program has to be left alone to begin cycling through words. Feel free to change this as well. To turn off demo mode completely just delete all the words in demowords, so it looks like this: demowords = [] and demo mode will never begin.

There's also a flag variable called randomword which, if True, will randomly pick words from demowords when in demo mode. If it's set to False then demo mode will go through demowords in order, looping back to the start once it reaches the end.