Skip to content

Commit 4ab5e41

Browse files
committed
small modifs
1 parent 68f5642 commit 4ab5e41

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Prerequisites:
1414
- [Pip](https://pypi.org/project/pip/)
1515

1616
Each script has its own requirements.txt which permits the installation of the required packages
17-
## Normal Order of operation
17+
## Normal order of operation
1818
Follow this flow chart in order to find which script to run depending on your need:
1919
![](img/calibration_flow.png)<br />
2020
## ExtractRawData
@@ -28,7 +28,7 @@ This script enables the user to extract the raw DW1000 data from the HiveBoard/B
2828
- To align the receiver with the emmiter, use the laser pointer. Each laser should point to the alignment target of the other laser assembly. This position ensures a 0 degree relative orientation between the two radio setup.
2929
- The laser mount should be calibrated periodicly to ensure its position and accuracy,
3030
#### Runnning the script
31-
The script can be run from `/src/extractRawData`
31+
The script can be run from `/src/extractRawData`.<br />
3232
Requires the [TestBench-Arduino](https://swarmus.github.io/SwarmUS-doc/) code to be installed on the test-bench's Arduino in order to be interfaced.
3333

3434
#### Adjustable parameters
@@ -53,7 +53,7 @@ Communication with the HiveBoard is done using the pheromones submodule. If comm
5353
## Parser
5454
Parses and presents the PDOA values from the previously acquired raw data (from [ExtractRawData](#pxtractRawData)). The user will be prompted 2 clickable interfaces to firstly offset the data to a common reference and secondly to extract the slopes of each antenna pair.
5555
#### Runnning the script
56-
The script can be run from `src/parser`
56+
The script can be run from `src/parser`.
5757
#### Adjustable parameters
5858
`dataFolderPath` : folder path where the extracted raw data CSV produced by [ExtractRawData](#pxtractRawData) has been save.<br />
5959
`dataName` : name of the file to parse the data from.<br />
@@ -77,7 +77,7 @@ A validation of these files can be done using the `testRead` function from the `
7777
## Send_angle_params
7878
Communicates to the Hiveboard the slope and caracteristics of the antenna pairs. Uses the pickle files created by [Parser](#parser). These files need to be placed in the calibration folder using the `hb_{HIVEBOARD_ID}` notation.<br />
7979
#### Runnning the script
80-
The script can be run from `/src/send_angle_params`
80+
The script can be run from `/src/send_angle_params`.
8181
#### Adjustable parameters
8282
`HIVEBOARD_ID` : the identification number of the Hiveboard. Can be found either in the flash memory or written on the RJ45 connector. <br />
8383
`MOUNT_ORIENTATION_OFFSET` : the rotation offest, in degrees, applied to the Beeboard assembly between the Test-bench setup at which the calibration was made, and the orientation on the robot or final installation.<br />
@@ -115,7 +115,7 @@ Communication with the HiveBoard is done using the pheromones submodule. If comm
115115
## Validate
116116
This is a method to test the whole angles system of the interlocalisation. Using the exact same hardware setup as the calibration it is possible to extract the angle value result from the whole acquisition, linearisation and certitude algorithm. Using the test-bench assembly will automate this procedure.
117117
#### Runnning the script
118-
The script can be run from `src/validate_interloc`<br />
118+
The script can be run from `src/validate_interloc`.<br />
119119
Requires the [TestBench-Arduino](https://swarmus.github.io/SwarmUS-doc/) code to be installed on the test-bench's Arduino in order to be interfaced.
120120
#### Hardware setup
121121
Refer to the [ExtractRawData](#extractRawData) hardware setup section for the protocol to ensure precise data acquisition.

0 commit comments

Comments
 (0)