Read the fine wiki first
UPDATED: 11 March 2021
The quickest way to get started with HASviolet is to
- Buy the hardware
- Clone the repo
- cd into the repo directory and run './HASviolet_install_fresh.sh'
- Read the fine manual
The root folder includes all apps and libraries. The following folders contain;
- apps Executables from previous releases yet to be ported
- cfg config files
- development code under development that could do dangerous things
- docs Home of RTFM
- server/static all files used by running WebGUI service
Party on!
During install, HASViolet_websox.py server is installed as a daemon under systemd. HASviolet_websox.sh can be used to stop/start/remove/status of the server.
On start, HASviolet_websox.py performs the following in order;
- loads SSL keys cfg/hasVIOLET.crt and cfg/hasVIOLET.key
- loads JSON file cfg/hasVIOLET.json
- listen for (browser) client connections on port 8000.
When a new client connects the following occur in order;
- Client is served server/static/hasVIOLET_LOGIN.html made pretty with server/static/hasVIOLET_LOGIN.css
- Client is required to authenticate using ID/password in cfg/hasVIOLET.pwf file
- Once authenticated, the client is redirected to the Dashboard server/static/hasVIOLET_INDEX.html made pretty with server/static/hasVIOLET.css.
- After the page is made pretty, static/hasVIOLET_INDEX.html tells the browser to load javascript from server/static/hasVIOLET.js
- Javascript instructs the client to the server and load cfg/hasVIOLET.json
The server runs two async processes;
- Tornado Web Framework providing web and websocket services
- LoRa Transceiver function (HASviolet)
When HASviolet sees a LoRa packet, it captures the message and sends a WebSocket client broadcast. When a TX request comes from the browser (client) via WebSockets, HASit.transmit function is called, transmits the LoRa packet and then trips a conditional inner-loop to restart recieving. We also use this trick if we want to change channels from the client which includes frequency, spreadfactor, coding, and bandwidth.
The framework uses SSLv3/TLS only. A untrusted self-signed certificate and server key are provided cfg/hasVIOLET.crt and cfg/hasVIOLET.key, respectively. But it is HIGHLY RECOMMENDED these be replaced with your own trusted credentials. Know until you have done that you will see (harmless) iostream errors from the websocket server like the following.
[SSL: SSLV3_ALERT_CERTIFICATE_UNKNOWN] sslv3 alert certificate unknown (_ssl.c:852)
cfg/hasVIOLET.pwf is a password file that stores ID and password pairs. An account management program is included called hasVIOLET_account.py to generate your own ID and password pairs into the password file. Passwords are stored as hashes to protect them. The password file is pre-populated with three ID:Password pairs provided as examples only and should be immediately replaced using the account program.
An annoying thing all browsers do is look for a FAVICON.ICO file. The file is a small image icon that some sites host and is displayed in your browser tab with the title of the web page. I created one cause I go tired of seeing an error in the Browser inspect console while I was building the app. If you want to create your own FAVICON.ICO, easiest way is from the following website that generates them.
The CSS code is what makes the WebUI shine. It is commented into sections that reference the grid containers they serve. The Tuner-Container CSS is the most complex out of all the sections. To best grasp CSS use start with reviewing Buttson CSS and Controls CSS sections. They serve the radio-controls, cmd-controls, and msg-control containers.
The CSS code for server/static/hasVIOLET_LOGIN.html
This code is loaded and run by the browser. To see it in action on the browser, after loading the web page (in Chrome) right click on empty page space and select Inspect then click on the Console tab The code generates alot of console.log infor here.
A confusing subject but hope the following tranlsates well;
rf95.setFrequency(911);
rf95.setSpreadingFactor(7);
rf95.setSignalBandwidth(125E3);
rf95.setCodingRate4(5);
rf95.setTxPower(20,false);
/*
//Different Combination for distance and speed examples:
Example 1: Bw = 125 kHz, Cr = 4/5, Sf = 128chips/symbol, CRC on. Default medium range = Bw125Cr45Sf128
rf95.setSignalBandwidth(125000);
rf95.setCodingRate4(5);
rf95.setSpreadingFactor(7);
Example 2: Bw = 500 kHz, Cr = 4/5, Sf = 128chips/symbol, CRC on. Fast+short range = Bw500Cr45Sf128?
rf95.setSignalBandwidth(500000);
rf95.setCodingRate4(5);
rf95.setSpreadingFactor(7);
Example 3: Bw = 31.25 kHz, Cr = 4/8, Sf = 512chips/symbol, CRC on. Slow+long range = Bw500Cr48Sf128?
rf95.setSignalBandwidth(31250);
rf95.setCodingRate4(8);
rf95.setSpreadingFactor(9);
Example 4: Bw = 125 kHz, Cr = 4/8, Sf = 4096chips/symbol, CRC on. Slow+long range = Bw125Cr48Sf512?
rf95.setSignalBandwidth(125000);
rf95.setCodingRate4(8);
rf95.setSpreadingFactor(12);