Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Stefal committed Jun 11, 2024
1 parent 22093c5 commit d069aeb
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Frontend's main features are:
Other images are available in the ./images folder.

## Ready to flash release:
A ready to flash image is available for Orange Pi Zero SBC : [Armbian_RTKBase](https://github.com/Stefal/build/releases/latest)
A ready to flash image is available for Orange Pi Zero, Orange Pi Zero 2, Orange Pi Zero 3 SBC : [Armbian_RTKBase](https://github.com/Stefal/build/releases/latest)

If you use a Raspberry Pi, thanks to [jancelin](https://github.com/jancelin), you can download a ready to flash iso file [here](https://github.com/jancelin/pi-gen/releases/latest).

Expand Down Expand Up @@ -126,7 +126,9 @@ The `install.sh` script can be used without the `--all` option to split the inst
-h | --help
Display this help message.
```

So, if you really want it, let's go for a manual installation with some explanations:

1. Install dependencies with `sudo ./install.sh --dependencies`, or do it manually with:
```bash
sudo apt update
Expand All @@ -138,7 +140,7 @@ So, if you really want it, let's go for a manual installation with some explanat

```bash
cd ~
wget -qO - https://github.com/rtklibexplorer/RTKLIB/archive/refs/tags/b34g.tar.gz | tar -xvz
wget -qO - https://github.com/rtklibexplorer/RTKLIB/archive/refs/tags/b34j.tar.gz | tar -xvz
```

+ compile and install str2str:
Expand Down Expand Up @@ -264,6 +266,8 @@ RTKBase use several RTKLIB `str2str` instances started with `run_cast.sh` as sys
The web GUI is available when the `rtkbase_web` service is running.

## Advanced:
+ Offline base station without U-Blox receiver, how to get date and time:
If gpsd can't understand the raw data from your gnss receiver, you can enable the raw2nmea service. It will convert the raw data to the tcp port set in `settings.conf` (nmea_port) and gpsd will use it to feed chrony. `systemctl enable --now rtkbase_raw2nmea`
+ Aerial images:
The default map background is OpenStreetMap, but you can switch to a worldwide aerial layer if you have a Maptiler key. To enable this layer, create a free account on [Maptiler](https://www.maptiler.com/), create a key and add it to `settings.conf` inside the `[general]` section:
`maptiler_key=your_key`
Expand All @@ -276,7 +280,7 @@ If you want to install RTKBase from the dev branch, you can do it with these com
cd ~
wget https://raw.githubusercontent.com/Stefal/rtkbase/dev/tools/install.sh -O install.sh
chmod +x install.sh
sudo ./install.sh --alldev dev
sudo ./install.sh --all repo --rtkbase-repo dev
```

## Other usages:
Expand All @@ -296,7 +300,7 @@ A gnss receiver with a timepulse output is a very accurate [stratum 0](https://e

+ Set gpsd and chrony to use PPS

+ gpsd: comment the `DEVICE` line in `/etc/defaut/gpsd` and uncomment `#DEVICES="tcp:\\127.0.0.1:5015 \dev\pps0`
+ gpsd: comment the `DEVICE` line in `/etc/defaut/gpsd` and uncomment `#DEVICES="tcp:\\127.0.0.1:5015 \dev\pps0`. Edit the port if you use the rtkbase_raw2nmea service.

+ chrony: inside `/etc/chrony/chrony.conf` uncomment the refclock pps line and add noselect to the 'refclock SHM 0`. You should have something like this:
```
Expand Down
Binary file modified images/internal.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/internal_synoptic.odp
Binary file not shown.

0 comments on commit d069aeb

Please sign in to comment.