Skip to content

Commit

Permalink
Update README to point to Wiki
Browse files Browse the repository at this point in the history
  • Loading branch information
@xawen
xawen committed Mar 25, 2024
1 parent 8e2d6ba commit 7c55f64
Showing 1 changed file with 3 additions and 153 deletions.
156 changes: 3 additions & 153 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Thanks to him for making this possible!

## Disclaimer
This firmware is a work in progress and could be unstable; it could alter your radio and its data.
Use at your own risk and remember to back up your SPI memory before installing any custom firmware.
Use at your own risk and remember to [back up your SPI memory](https://github.com/OEFW-community/RT-890-custom-firmware/wiki/SPI) before installing any custom firmware. DO NOT SKIP THIS STEP.

## Features
- All stock features: [check user's manual](https://cdn.shopifycdn.net/s/files/1/0564/8855/8800/files/RT-890_user_manual.pdf?v=1670288968)
Expand All @@ -32,166 +32,16 @@ Use at your own risk and remember to back up your SPI memory before installing a
- Ability to disable LED toggling when scanning
- And much more!

### Default Shortcut Keys (long press) - Configurable in main menu
```
1 => Start/stop scanning memory channels
2 => Toggle AM fix
3 => Toggle VOX
4 => Change TX power on current channel
5 => Change squelch level
6 => Toggle dual watch
7 => Toggle backlight
8 => Change frequency step
9 => Go to Preset Channel
0 => Launch broadcast FM mode
* => Edit TX frequency on current channel
# => Toggle key lock
Menu => DTMF decoder
Exit => Single/dual VFO display
```

### Tunable Squelch - Configurable in main menu
The squelch mode can be set in the main menu. This setting affects what variables the radio will use to determine the squelch open/close level. There are 4 modes available:
- RSSI (R)
- RSSI + Noise (R + N)
- RSSI + Glitch (R + G)
- RSSI + Noise + Glitch (R + N + G)

Overall squelch levels (0-9) can be set from the SQL Level option in main menu (or the Shortcut Key Action). These levels affect the squelch RSSI, Noise and Glitch settings on the radio chip. The levels 0-9 are offsets from a base value for each setting. These base values can be tuned for your specific radio using the Squelch RSSI, Squelch Noise and Squelch Glitch settings in the main menu.

Default squelch settings:
```
Mode => R + N + G
RSSI => 94 (Hex: 0x5E)
Noise => 68 (Hex: 0x44)
Glitch => 17 (Hex: 0x11)
```

### Scanning guide
Scan list management:
- This firmware has 8 scanlists.
- The current channel can be added to any scanlist using the `Ch In List X` menus.
- The scanlist to be used can be selected in the `List To Scan` menu.
- To ignore scanlists and scan all channels, select `*` in the `List To Scan` menu.
- To add/remove current channel to current scanlist, use the `Toggle SList` shortcut.

Scanning:
- To start scanning, press a key mapped to the `Freq scanner` shortcut (default: long press on key `1`).
- When scanning is in progress, use the `Freq scanner` key to change the scan list, this action will move to the next non-empty scanlist, or switch to scan all mode if all subsequent lists are empty.
- To change the direction of current scan, use the `up`/`down` keys.
- To force the scan to resume when the scanner stops on a signal, use the `up`/`down` keys.
- Press any key other than `Freq scanner` or `Up`/`Down` to stop scanning.
- `Exit` key will restore the frequency or channel that was active before scanning started.
- `Menu` key will restore the last frequency or channel on wich the scanner stopped.
- Any other key will stop the scanner where it is.

### Spectrum Usage
Start spectrum by mapping a key (side key or keypad) to the Spectrum action using the main menu. Spectrum will launch, centered on the frequency from the active VFO/Memory Channel.

Spectrum keys:
```
Up => Normal: Increase frequency range by frequency +/- (number in middle of bottom row)
Holding on a frequency: Move up to the next frequency
Down => Normal: Decrease frequency range by frequency +/- (number in middle of bottom row)
Holding on a frequency: Move down to the previous frequency
1 => Change number of scan steps (16, 32, 64 or 128)
2 => Switch up to next preset
3 => Change modulation (AM, FM or SSB)
4 => Change step size (0.25k - 50k)
5 => Switch down to previous preset
6 => Inrease squelch level
7 => Hold on current frequency
8 => Toggle between bars and waterfall views
9 => Decrease squelch level
0 => Toggle filter (U = unfiltered, F = filtered)
* => Change scan delay (0 - 10ms)
# => Toggle bandwidth (W = wide, N = narrow)
Menu => Jump to VFO mode with current frequency and settings (to allow TX)
Exit => Exit spectrum
```
Spectrum display:
<p float="left">
<img src="/Images/SpectrumDisplay.png" height=300 />
</p>

### Register Editor Usage
Register Editor must be enabled with a Makefile flag. It is off by default to save space. Start register by mapping a key (side key or keypad) to the Reg Editor action using the main menu. Register Editor will launch, showing the current register values in blue. The register currently being edited will display in large white font.

Register Editor keys:
```
Up => Move editor to next register
Down => Move to previous register
1 => Change AGC level
2 => Decrease value of current register's setting by 1
3 => Increase value of current register's setting by 1
5 => Decrease value of current register's setting by 10
6 => Increase value of current register's setting by 10
8 => Decrease value of current register's setting by 100
9 => Increase value of current register's setting by 100
Exit => Exit Register Editor
```

Note: There is also an key action (mappable to any key) that will cycle through the AGC levels. To use this assign the AGC Mode action to a key. It will cycle between Auto AGC and Fixed AGC levels 1-7. This action is available even if the Register Editor Makefile flag is disabled.

## Update Instructions
### SPI memory backup
Use [RT-890-Flasher](https://github.com/OEFW-community/radtel-rt-890-flasher)

### SPI memory restore
Use [RT-890-SPI-restore-CLI](https://github.com/OEFW-community/RT-890-SPI-Restore-CLI)

### Customizations
```
UART_DEBUG => UART debug output
MOTO_STARTUP_TONE => Moto XPS startup beeps
ENABLE_AM_FIX => Experimental port of the great UV-K5 AM fix from OneOfEleven
ENABLE_ALT_SQUELCH => Port of optimized UV-K5 squelch system from various firmwares
ENABLE_STATUS_BAR_LINE => Display status bar separator line
ENABLE_NOAA => NOAA weather channels (always re-set the sidekeys actions from menu after modifying the available actions)
ENABLE_SPECTRUM => Spectrum frequency view (assign to a shortcut key to access)
ENABLE_SPECTRUM_PRESETS => Band presets for Spectrum mode (ENABLE_SPECTRUM required to be enabled)
ENABLE_FM_RADIO => FM broadcast radio mode
ENABLE_LTO => Link Time Optimization
ENABLE_OPTIMIZED => Compiler options to reduce binary size
ENABLE_SLOWER_RSSI_TIMER => Slower update rate of RSSI to reduce screen updates that cause reports of clicking around 444-446MHz
ENABLE_RX_BAR => Display RSSI level bar when RX
ENABLE_TX_BAR => Display vox level bar when TX
ENABLE_SCANLIST_DISPLAY => Display scanlists membership instead of empty RSSI grid in channel mode when radio not RX/TX
ENABLE_KEEP_MONITOR_MODE_UP_DN => Keep monitor mode when pressing up/down keys to change frequency
```

### Build & Flash
See __Compiler__, __Building__ and __Flashing__ sections below.
## Usage and feature instructions
See the [Wiki in this repository](https://github.com/OEFW-community/RT-890-custom-firmware/wiki) for detailed usage instructions.

## Pre-built firmware
You can find pre-built firmwares in the [Actions](https://github.com/OEFW-community/RT-890-custom-firmware/actions)

## Building from browser

To build the firmware without installing any software you can run a full featured IDE and compiler in your browser using GitHub Codespace.
The preconfigured environment runs Linux Ubuntu 22.04 with gcc-arm-none-eabi 15:10.3-2021.07-4.

### Starting a new Codespace

You just need to clic on the green button `<> Code` -> `Codespace` -> `Create Codespace on ...`
After the Codespace is initialized, you can open and edit any file, for example, modify the options in the makefile and build the firmware typing `make` in the terminal panel.

### Starting an existing Codespace

If you started a Codespace less than 7 days ago and have not manually deleted it, then you will be offered to restart it instead of creating a new one.
The start-up will be much faster but you will need to update the code before compiling as it will contain the version of the code from the time of its creation.
To do this, simply type the following commands in the console: `make clean`, then `git pull`, and finally `make`.

### A word about the free offer
The most observant users will have noticed this message: `Codespace usage for this repository is paid for by...`
Github will never charge you without consent. If you reach the limit of the free offer, which is very unlikely, you will not be able to start your codespaces until the monthly limits reset, that's all.
[More informations](https://docs.github.com/en/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces)

## Telegram group
If you want to discuss this project, you can join the [Telegram group](https://t.me/RT890_OEFW).



---
_Original OEFW readme_

Expand Down

0 comments on commit 7c55f64

Please sign in to comment.