From d97a104f34c69a4c0e960dbb3d6ee00d96b89569 Mon Sep 17 00:00:00 2001 From: Rodrigo Alfonso Date: Tue, 27 Aug 2024 01:20:34 -0300 Subject: [PATCH] Updating asyncACKTimerId docs --- README.md | 2 +- lib/LinkWireless.hpp | 5 +++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 41b2573..70bf997 100644 --- a/README.md +++ b/README.md @@ -199,7 +199,7 @@ Name | Type | Default | Description `timeout` | **u32** | `10` | Maximum number of *frames* without receiving data from other player before resetting the connection. `interval` | **u16** | `50` | Number of *1024-cycle ticks* (61.04μs) between transfers *(50 = 3.052ms)*. It's the interval of Timer #`sendTimerId`. Lower values will transfer faster but also consume more CPU. You can use `Link::perFrame(...)` to convert from *packets per frame* to *interval values*. `sendTimerId` | **u8** *(0~3)* | `3` | GBA Timer to use for sending. -`asyncACKTimerId` | **s8** *(0~3 or -1)* | `-1` | GBA Timer to use for ACKs. If you have free timers, use one here to reduce CPU usage. +`asyncACKTimerId` | **s8** *(0~3 or -1)* | `-1` | This GBA timer is used to asynchronously acknowledge the adapter transfers. It is disabled by default, with the acknowledgment procedure performed during SERIAL interrupts. You can update these values at any time without creating a new instance: - Call `deactivate()`. diff --git a/lib/LinkWireless.hpp b/lib/LinkWireless.hpp index 3596940..4aea998 100644 --- a/lib/LinkWireless.hpp +++ b/lib/LinkWireless.hpp @@ -304,8 +304,9 @@ class LinkWireless { * *(50 = 3.052ms)*. It's the interval of Timer #`sendTimerId`. Lower values * will transfer faster but also consume more CPU. * @param sendTimerId GBA Timer to use for sending. - * @param asyncACKTimerId GBA Timer to use for ACKs. If you have free timers, - * use one here to reduce CPU usage. + * @param asyncACKTimerId This GBA timer is used to asynchronously acknowledge + * the adapter transfers. It is disabled by default, with the acknowledgment + * procedure performed during SERIAL interrupts. * \warning You can use `Link::perFrame(...)` to convert from *packets per * frame* to *interval values*. */