Skip to content

Commit 8a63d3e

Browse files
committed
updates readme and clarifies some language
1 parent 4b3325c commit 8a63d3e

2 files changed

Lines changed: 29 additions & 8 deletions

File tree

README.md

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,10 @@ This application and additional documentation on Point One devices, protocols, a
1616
- [`p1_runner` - Log Data And Receive GNSS Corrections In Real Time](#p1_runner---log-data-and-receive-gnss-corrections-in-real-time)
1717
- [Basic Usage](#basic-usage)
1818
- [Sending GNSS Corrections](#sending-gnss-corrections)
19-
- [`config_tool` - Read/Write Device Configuration](#config_tool---readwrite-device-configuration)
19+
- [`config_wizard` - Simple Setup Wizard](#config_wizard---simple-setup-wizard)
2020
- [Basic Usage](#basic-usage-1)
21+
- [`config_tool` - Read/Write Device Configuration](#config_tool---readwrite-device-configuration)
22+
- [Basic Usage](#basic-usage-2)
2123
- [Saving Changes](#saving-changes)
2224
- [`device_bridge` - Connect Two Devices Through The Host Computer](#device_bridge---connect-two-devices-through-the-host-computer)
2325

@@ -87,7 +89,7 @@ The following sections cover the most common use case. See `runner.py --help` fo
8789

8890
### Basic Usage
8991

90-
1. Connect a USB cable from the Point One device to your host computer.
92+
1. Connect a USB cable from the Point One device to your host computer (if USB)
9193
2. If used, activate the Python virtual environment as described in [Setup / Installation](#setup--installation).
9294
3. Run p1_runner to connect the device.
9395

@@ -123,6 +125,23 @@ To use another NTRIP service, use the `--ntrip` argument, specifying URL, mountp
123125
$ python3 bin/runner.py --ntrip http://corrections.com:2101,my_mountpoint,my_username,my_password
124126
```
125127

128+
## `config_wizard` - Simple Setup Wizard
129+
130+
`config_wizard.py` is an easy to use tool to query and update basic settings and stored data of a Point One device.
131+
132+
### Basic Usage
133+
134+
1. Connect a USB cable from the Point One device to your host computer (if USB). For IP based devices, get your device's IP address.
135+
2. If used, activate the Python virtual environment as described in [Setup / Installation](#setup--installation).
136+
3. Run config_tool to connect the device.
137+
138+
Linux: `python3 bin/config_wizard.py ADDRESS`
139+
140+
Windows: `python bin/config_wizard.py ADDRESS`
141+
142+
Where `ADDRESS` is something like 192.168.0.1, COM3, /dev/ttyUSB0, or serial://COM3.
143+
144+
126145
## `config_tool` - Read/Write Device Configuration
127146

128147
`config_tool.py` can be used to query and update the setting and stored data on a Point One device.
@@ -131,7 +150,7 @@ The following sections cover the most common use case. See `config_tool.py --hel
131150

132151
### Basic Usage
133152

134-
1. Connect a USB cable from the Point One device to your host computer.
153+
1. Connect a USB cable from the Point One device to your host computer (if used). For IP based devices, get your device's IP address.
135154
2. If used, activate the Python virtual environment as described in [Setup / Installation](#setup--installation).
136155
3. Run config_tool to connect the device.
137156

bin/config_wizard.py

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
Interactive configuration wizard for Point One devices.
55
66
This wizard guides users through configuring key device parameters:
7-
- IMU lever arm (X, Y, Z)
8-
- GPS lever arm (X, Y, Z)
7+
- Body to IMU lever arm (X, Y, Z)
8+
- Body to GPS lever arm (X, Y, Z)
99
- Device orientation (Z axis direction, X axis direction)
1010
"""
1111

@@ -280,7 +280,8 @@ def main():
280280

281281
# IMU Lever Arm
282282
print_section("IMU to Body Lever Arm (meters)")
283-
print("Enter the offset from the vehicle body origin to the IMU.")
283+
print("Enter the distance from the vehicle body origin to the IMU.")
284+
print("The vehicle body origin is usually the center of the rear axle.")
284285
print(" +X = Forward, +Y = Left, +Z = Up")
285286
print()
286287

@@ -295,8 +296,9 @@ def main():
295296
changes.append(('IMU Lever Arm', new_device_lever_arm))
296297

297298
# GPS Lever Arm
298-
print_section("GPS Antenna to Body Lever Arm (meters)")
299-
print("Enter the offset from the vehicle body origin to the GPS antenna.")
299+
print_section("Body to GPS Antenna Lever Arm (meters)")
300+
print("Enter the distance from the vehicle body origin to the GPS antenna.")
301+
print("The vehicle body origin is usually the center of the rear axle.")
300302
print(" +X = Forward, +Y = Left, +Z = Up")
301303
print()
302304

0 commit comments

Comments
 (0)