Skip to content

Commit f1a8126

Browse files
Update docs
Update KiCAD files with proper filepaths and/or alignment for the 3D model of the GNSS modules Update/add assembly photos Add more instructions for RxTools software Add template image for the pinouts of the Flex headers
1 parent 8894607 commit f1a8126

File tree

8 files changed

+180
-0
lines changed

8 files changed

+180
-0
lines changed
-62 Bytes
Binary file not shown.
-109 KB
Loading
1 Byte
Binary file not shown.
371 KB
Loading
-1 Bytes
Binary file not shown.
Lines changed: 179 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,179 @@
1+
!!! note
2+
The system requirements and installation instructions are from the RxTools *v22.1.0* user manual. This information may change in later iterations of the software suite. Please refer to the user manual *(of the version you are utilizing)* for the most accurate information.
3+
4+
5+
6+
# RxTools Software Suite
7+
!!! tip
8+
Even if you aren't necessarily interested it, we highly recommend that users install the [RXTools software suite](https://www.septentrio.com/en/products/gps-gnss-receiver-software/rxtools) before plugging in their board. For Windows PCs, it also includes the USB driver for the module that enables the Ethernet-over-USB support and virtual `COM` ports.
9+
10+
11+
Users should install the [RXTools software suite](https://www.septentrio.com/en/products/gps-gnss-receiver-software/rxtools) on their computer to interact with the mosaic-X5 module through the USB interface. The software package includes the USB-IP driver[^1] necessary to recognize the board as an ethernet device on Windows PCs (1).
12+
{ .annotate }
13+
14+
1. On Linux, the standard Linux CDC-ACM driver is suitable.
15+
16+
[^1]: On Linux, the standard Linux CDC-ACM driver is suitable.
17+
18+
19+
<article style="text-align: center;" markdown>
20+
[:octicons-download-16:{ .heart } Download the RxTools Software from Septentrio](https://www.septentrio.com/en/products/gps-gnss-receiver-software/rxtools){ .md-button .md-button--primary target="blank" }
21+
</article>
22+
23+
## System Requirements
24+
25+
<div class="grid" markdown>
26+
27+
<div markdown>
28+
29+
### Operating System
30+
31+
---
32+
33+
- Windows 7
34+
- Windows 8
35+
- Windows 10
36+
- Fedora 23 *(or later)* using Qt technology.
37+
- The standalone tools (except `bin2asc`) will run on older distributions.
38+
39+
</div>
40+
41+
<div markdown>
42+
43+
### Hardware Requirements
44+
45+
---
46+
47+
The minimal hardware requirements *(1Hz update[^2])*:
48+
49+
- CPU: 1 GHz processor
50+
- RAM: 1 GB RAM
51+
- Screen Resolution: 1024×768 or higher resolution
52+
53+
</div>
54+
55+
</div>
56+
57+
58+
[^2]: Higher data rates will require higher CPU speed and more memory capacity.
59+
60+
## Installation Instructions
61+
62+
### Windows
63+
Users can install RxTools software suite by running the installation executable[^3](1), located in the `RxTools\windows` directory of the downloaded `*.zip` file[^4]. During the installation process, users will be notified if a previous version of RxTools is already installed then that the previous version will be uninstalled. Next, users will need to provide an installation directory for the RxTools software suite. Users will then select which of the following applications[^5] are installed:
64+
{ .annotate }
65+
66+
1. For RxTools v22.1.0, the installation filename is `RxTools_22_1_0_Installer.exe` for Windows PCs.
67+
68+
<!-- Create Break from Annotation (list won't render without comment)-->
69+
70+
<div class="grid" markdown>
71+
72+
<div markdown>
73+
74+
- RxControl
75+
- SBF Converter
76+
- SBF Analyzer
77+
- RxLogger
78+
79+
</div>
80+
81+
<div markdown>
82+
83+
- RxUpgrade
84+
- RxDownload
85+
- RxPlanner
86+
87+
</div>
88+
89+
<div markdown>
90+
91+
- Data Link
92+
- RxAssistant
93+
- RxLauncher
94+
95+
</div>
96+
97+
</div>
98+
99+
100+
### Linux
101+
!!! warning
102+
It is recommended that users **<span style="color:red">NOT</span>** install RxControl as `root`, for security reasons and to avoid installation overwrites of other system settings. To make RxTools available to more than one user, provide a shared installation directory.
103+
104+
Users can install RxTools software suite by running the installation binary[^3](1), located in the `RxTools/linux-i386/` directory of the downloaded `*.zip` file[^4]. During the installation, users will be prompted for an installation directory. If there are any previous installations of RxControl, please use a different directory to avoid conflicts.
105+
{ .annotate }
106+
107+
1. For RxTools v22.1.0, the installation filename is `RxTools_22_1_0_Installer.bin` for Linux.
108+
109+
??? info "Permission Settings"
110+
Once installed, users may need to reconfigure their permission settings:
111+
112+
<div class="annotate" markdown>
113+
114+
- RxTools will need rights to access the `/dev/ttyS*` serial ports.
115+
116+
- To access the serial ports, users must be part of the `uucp` and `lock` groups (1). This can be configured by editing the `/etc/group`[^6] file and adding the username to the lines defining the `uucp` group and the `lock` group.
117+
118+
For example, when adding the user `jsmith` to the `uucp` group, users would modify the `/etc/group` file as shown below:
119+
120+
```bash
121+
{--uucp:x:14:uucp--} # (2)!
122+
{++uucp:x:14:uucp,jsmith++} # (3)!
123+
```
124+
125+
- On Linux machine administered centrally on a local network, ask your system administrator to be included in the `uucp` and `lock` groups.
126+
- RxTools also needs read/write (`rw`) access(4) to the `/dev/ttyS*` serial ports.
127+
128+
- Users can change the permissions with the `chmod`[^7] command:
129+
130+
```bash
131+
chmod 660 /dev/ttyS<add port> # (5)!>
132+
```
133+
134+
</div>
135+
136+
1. On most Linux operating systems, the `/dev/ttyS*` devices are owned by `root` and belong to the `uucp` group with read/write (`rw`) access. Additionally, the devices are normally locked by writing a file in the `/var/lock/` directory, with the same permissions.
137+
2. Remove
138+
3. Replace with this line
139+
4. By default, users will normally have read/write (`rw`) access to the `/dev/ttyS*` serial ports.
140+
5. where users must specify the port number<br>*e.g. `/dev/ttyS0` might be port `COM1`*
141+
142+
!!! note
143+
In order for these changes to take effect, users must update their environment by logging out and back in.
144+
145+
Be aware that the X-session has to be restarted as well. On most systems, this can be done by pressing the key combination ++ctrl++ + ++alt++ + ++backspace++
146+
147+
??? info "64-bit OS"
148+
In order to run the RxTools on a 64-bit Linux operating system, users might to install the 32-bit version of the `C` standard library.
149+
150+
- For Fedora installations, this is the `glibc.i686` package.
151+
- The equivalent for Debian(/Ubuntu) installations is the `ia32-libs` package.
152+
153+
154+
[^3]: Users will need administrative privileges to install the RxTools software.
155+
[^4]: Users may need to extract the RxTools installation files from the downloaded, compressed file.
156+
[^5]: Please see the release notes for the issues and limitations of the RxTools applications.
157+
[^6]: Requires c privileges.
158+
[^7]: Changing these permissions also requires `root` privileges.
159+
160+
## Getting Started
161+
162+
### Windows
163+
Once **RxTools** have been installed, any of the individual GUI tools can be launched using the **RxLauncher** application.
164+
165+
When connecting to a receiver using USB, two virtual serial ports will be created on your machine which can be used to communicate to the receiver.
166+
167+
- Check the Device Manager to see the exact names of these virtual serial ports.
168+
- They ports will appear with the name `Septentrio` written beside them.
169+
- These virtual serial ports will be labeled as such when **RxControl** shows the Connection Dialog.
170+
171+
!!! tip
172+
The virtual serial port names correspond to a given USB port. When plugging the device into a different USB port, the serial port will change.
173+
174+
### Linux
175+
Once **RxControl** is installed, it can be launched by executing the link created by the installation program or by executing `./runRxControl` in the directory where the program is installed.
176+
177+
- The **Data Link** and **SBF Converter** applications should be executed from the `/bin` directory of the installation folder, to ensure that the proper libraries are loaded. Users can also run these applications from the installation directory, in a manner similar to **RxControl** that is described above.
178+
- Other applications can also be executed by launching their appropriate script.
179+
- For example, users can execute `./runDataLink` from the `/bin` directory, located inside the installation folder.

flex_boards/SparkPNT_GNSS_Flex_Module_mosaic-X5/mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,6 @@ nav:
1818
- Advanced Configurations:
1919
- Enable GNSS Signals: gnss_signals.md
2020
- Web Interface: web_interface.md
21+
- RxTools Software Suite: rxtools.md
2122
- Troubleshooting Tips: troubleshooting_tips.md
2223
- Resources: resources.md
4.71 MB
Binary file not shown.

0 commit comments

Comments
 (0)