diff --git a/docs/api.md b/docs/api.md index 11ef7f4..6b356a5 100644 --- a/docs/api.md +++ b/docs/api.md @@ -20,7 +20,7 @@ AdvancedADC adc(analogPin); `void`. -### `begin()` +### `AdvancedADC.begin()` Initializes and configures the ADC with the specified parameters. To reconfigure the ADC, `stop()` must be called first. @@ -56,7 +56,7 @@ adc0.begin(resolution, sample_rate, n_samples, n_buffers) 1 on success, 0 on failure. -### `available()` +### `AdvancedADC.available()` Checks if the ADC is readable. @@ -74,11 +74,11 @@ None. Returns true, if there's at least one sample buffer in the read queue, otherwise returns false. -### `read()` +### `AdvancedADC.read()` Returns a sample buffer from the queue for reading. -### `start()` +### `AdvancedADC.start()` Starts the ADC sampling. @@ -92,7 +92,7 @@ adc.start() 1 on success, 0 on failure. -### `stop()` +### `AdvancedADC.stop()` Stops the ADC and releases all of its resources. @@ -127,7 +127,7 @@ AdvancedADCDual adc_dual(adc1, adc2); `void`. -### `begin()` +### `AdvancedADCDual.begin()` Initializes and starts the two ADCs with the specified parameters. @@ -162,7 +162,7 @@ adc_dual.begin(resolution, sample_rate, n_samples, n_buffers) 1 on success, 0 on failure. -### `stop()` +### `AdvancedADCDual.stop()` Stops the dual ADCs and releases all resources. @@ -187,7 +187,7 @@ AdvancedDAC dac1(A13); `void`. -### `begin()` +### `AdvancedDAC.begin()` Initializes the DAC with the specified parameters. To reconfigure the DAC, `stop()` must be called first. @@ -211,7 +211,7 @@ dac.begin(resolution, frequency, n_samples, n_buffers) 1 on success, 0 on failure. -### `available()` +### `AdvancedDAC.available()` Checks if the DAC is writable. @@ -229,7 +229,7 @@ None. Returns true, if there's at least one free sample buffer in the write queue, otherwise returns false. -### `dequeue()` +### `AdvancedDAC.dequeue()` Returns a sample buffer from the queue for writing. @@ -245,7 +245,7 @@ for (size_t i=0; i