Skip to content

Commit

Permalink
Update README.md with instructions on calibration
Browse files Browse the repository at this point in the history
  • Loading branch information
Abogical authored May 8, 2024
1 parent 8759808 commit 504dee1
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Install dependencies first with `pip install -r requirements.txt`

### Calibration
```
usage: calibrate [-h] [-p CONTROLLER_PORT] --checkerboard-dims CHECKERBOARD_DIMS [--square-size SQUARE_SIZE] [-o OUTPUT]
python3 -m camoperator.calibrate [-h] [-p CONTROLLER_PORT] --checkerboard-dims CHECKERBOARD_DIMS [--square-size SQUARE_SIZE] [-o OUTPUT]
Gets calibration information from the camera via capturing a checkerboard image.
Expand All @@ -26,8 +26,13 @@ options:
-o OUTPUT, --output OUTPUT
Output filename, default is stdout
```
The configuration is a JSON file that is usually saved in the images folder where the capture process will store images to. The capture process will automatically read this config file if
found in the folder it saves to.
The configuration is a JSON file that is usually saved in the images folder where the capture process will store images to. The capture process will automatically read this config file if it is
found in the folder it saves to with the filename `config.json`. A checkerboard image needs to be in the photo with the checkerboard dimensions specified.

#### Example
```
python3 -m camoperator.calibrate -p /dev/ttyUSB0 -o ./images/config.json
```

### Capture
```
Expand Down

0 comments on commit 504dee1

Please sign in to comment.