Skip to content

Commit 3e5c84d

Browse files
committed
Update readme
1 parent 400afec commit 3e5c84d

File tree

1 file changed

+25
-10
lines changed

1 file changed

+25
-10
lines changed

README.md

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,26 +8,41 @@ The API is stable, but it might change without previous announce.
88

99
## Content
1010

11-
- [Precomiled FW](#Precompiled)
12-
- [Using the API](#Usage)
13-
- [Build it yourself](#Build)
11+
- [Precomiled FW (the easy way)](#precomiled-fw-the-easy-way)
12+
- [Using the API](#using-the-api)
13+
- [Importing the camera module](#importing-the-camera-module)
14+
- [Creating a camera object](#creating-a-camera-object)
15+
- [Initializing the camera](#initializing-the-camera)
16+
- [Capture image](#capture-image)
17+
- [Convert image to another format](#convert-image-to-another-format)
18+
- [Camera reconfiguration](#camera-reconfiguration)
19+
- [Additional methods](#additional-methods)
20+
- [Additional information](#additional-information)
21+
- [Build your custom FW](#build-your-custom-fw)
22+
- [Setting up the build environment (DIY method)](#setting-up-the-build-environment-diy-method)
23+
- [Add camera configurations to your board (optional, but recommended)](#add-camera-configurations-to-your-board-optional-but-recommended)
24+
- [Supported camera models](#supported-camera-models)
25+
- [For unsupported camera models](#for-unsupported-camera-models)
26+
- [Customize additional camera settings](#customize-additional-camera-settings)
27+
- [Build the API](#build-the-api)
1428
- [Notes](#notes)
1529
- [Benchmark](#benchmark)
30+
- [Troubleshooting](#troubleshooting)
1631
- [Donate](#donate)
1732

18-
## Precomiled FW (the easy way) <a name="Precompiled">
33+
## Precomiled FW (the easy way)
1934

2035
If you are not familiar with building custom firmware, visit the [releases](https://github.com/cnadler86/micropython-camera-API/releases) page to download firmware that suits your board. **There are over 20 precompiled board images with the latest micropython!**
2136

22-
## Using the API <a name="Usage">
37+
## Using the API
2338

24-
### Importing the Camera Module
39+
### Importing the camera module
2540

2641
```python
2742
from camera import Camera, GrabMode, PixelFormat, FrameSize, GainCeiling
2843
```
2944

30-
### Creating a Camera Object
45+
### Creating a camera object
3146

3247
Camera construction using defaults. This is the case if you are using a **non-generic** precompiled firmware or if you specified the camera model or pins in mpconfigboard.h during your build. Then you can just call the construction without any keyword arguments.
3348

@@ -99,7 +114,7 @@ The following keyword arguments have default values:
99114
- LATEST for ESP32S3 boards
100115
- WHEN_EMPTY for all other
101116

102-
### Initializing the Camera
117+
### Initializing the camera
103118

104119
```python
105120
cam.init()
@@ -172,7 +187,7 @@ vers = camera.Version()
172187

173188
The FW images support the following cameras out of the box, but is therefore big: OV7670, OV7725, OV2640, OV3660, OV5640, NT99141, GC2145, GC032A, GC0308, BF3005, BF20A6, SC030IOT
174189

175-
## Build your custom FW <a name="Build">
190+
## Build your custom FW
176191

177192
### Setting up the build environment (DIY method)
178193

@@ -191,7 +206,7 @@ Alternatively, you can clone the <https://github.com/espressif/esp32-camera> rep
191206
192207
### Add camera configurations to your board (optional, but recommended)
193208
194-
#### Supported Camera Models
209+
#### Supported camera models
195210
196211
This project supports various boards with camera interface out of the box. You typically only need to add a single line to your board config file ("mpconfigboard.h).
197212
Example (don't forget to add the empty line at the bottom):

0 commit comments

Comments
 (0)