diff options
| -rw-r--r-- | doc/main.md | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/doc/main.md b/doc/main.md index d27f6f5..5c35a1c 100644 --- a/doc/main.md +++ b/doc/main.md @@ -474,17 +474,17 @@ For a detailed description on what these functions do, look at [FT245.md](FT245. 1. Include the `FT245.h` file into your source. 2. This driver can be used in static or dynamic mode. If you have just one FT245 master in your project, the static mode is recommended for simplicity and speed. If you have multiple FT245 masters in your project, dynamic mode is recommended to easier manage multiple FT245 instances. - 2.1. Static mode - 2.1.1. Set the define `FT245_DRIVER_MODE_STATIC` to `1` either before including `FT245.h` or inside `FT245.h`. - 2.1.2. Implement the `Static mode external functions` in your source code. - 2.1.3. Instantiate the `ft245_t` instance. - 2.1.4. Initialize the instance with `FT245_init(...)`. - 2.2. Dynamic mode - 2.2.1. Set the define `FT245_DRIVER_MODE_DYNAMIC` to `1` either before including `FT245.h` or inside `FT245.h`. - 2.2.2. Implement the `Dynamic mode external functions` in your source code. - 2.2.3. Instantiate a `ft245_t` instance for each FT245 in your setup. - 2.2.4. Assign the `Dynamic mode external functions` in the `ft245_t` instance to your implemented functions. - 2.2.5. Initialize each instance with `FT245_init(...)`. + 2.1. Static mode + 2.1.1. Set the define `FT245_DRIVER_MODE_STATIC` to `1` either before including `FT245.h` or inside `FT245.h`. + 2.1.2. Implement the `Static mode external functions` in your source code. + 2.1.3. Instantiate the `ft245_t` instance. + 2.1.4. Initialize the instance with `FT245_init(...)`. + 2.2. Dynamic mode + 2.2.1. Set the define `FT245_DRIVER_MODE_DYNAMIC` to `1` either before including `FT245.h` or inside `FT245.h`. + 2.2.2. Implement the `Dynamic mode external functions` in your source code. + 2.2.3. Instantiate a `ft245_t` instance for each FT245 in your setup. + 2.2.4. Assign the `Dynamic mode external functions` in the `ft245_t` instance to your implemented functions. + 2.2.5. Initialize each instance with `FT245_init(...)`. 3. Define the TX buffer size by setting `FT245_BUFFER_SIZE_TX` either before including `FT245.h` or inside `FT245.h`. 4. Define the RX buffer size by setting `FT245_BUFFER_SIZE_TX` either before including `FT245.h` or inside `FT245.h`. 5. Make sure the `FT245_periodic(...)` is called periodically, either via timer interrupt or in a loop. |