summaryrefslogtreecommitdiff
path: root/shared-bindings/pulseio
diff options
context:
space:
mode:
Diffstat (limited to 'shared-bindings/pulseio')
-rw-r--r--shared-bindings/pulseio/PWMOut.c7
-rw-r--r--shared-bindings/pulseio/PulseIn.c12
-rw-r--r--shared-bindings/pulseio/PulseOut.c13
-rw-r--r--shared-bindings/pulseio/__init__.c16
4 files changed, 9 insertions, 39 deletions
diff --git a/shared-bindings/pulseio/PWMOut.c b/shared-bindings/pulseio/PWMOut.c
index 3a25d6938..7970c02f3 100644
--- a/shared-bindings/pulseio/PWMOut.c
+++ b/shared-bindings/pulseio/PWMOut.c
@@ -36,12 +36,7 @@
#include "supervisor/shared/translate.h"
//| class PWMOut:
-//| """.. currentmodule:: pulseio
-//|
-//| :class:`PWMOut` -- Output a Pulse Width Modulated signal
-//| ========================================================
-//|
-//| PWMOut can be used to output a PWM signal on a given pin."""
+//| """Output a Pulse Width Modulated signal on a given pin."""
//|
//| def __init__(self, pin: microcontroller.Pin, *, duty_cycle: int = 0, frequency: int = 500, variable_frequency: bool = False):
//| """Create a PWM object associated with the given pin. This allows you to
diff --git a/shared-bindings/pulseio/PulseIn.c b/shared-bindings/pulseio/PulseIn.c
index 9024f53e3..5c52b2582 100644
--- a/shared-bindings/pulseio/PulseIn.c
+++ b/shared-bindings/pulseio/PulseIn.c
@@ -36,15 +36,9 @@
#include "supervisor/shared/translate.h"
//| class PulseIn:
-//| """.. currentmodule:: pulseio
-//|
-//| :class:`PulseIn` -- Read a series of pulse durations
-//| ========================================================
-//|
-//| PulseIn is used to measure a series of active and idle pulses. This is
-//| commonly used in infrared receivers and low cost temperature sensors (DHT).
-//| The pulsed signal consists of timed active and idle periods. Unlike PWM,
-//| there is no set duration for active and idle pairs."""
+//| """Measure a series of active and idle pulses. This is commonly used in infrared receivers
+//| and low cost temperature sensors (DHT). The pulsed signal consists of timed active and
+//| idle periods. Unlike PWM, there is no set duration for active and idle pairs."""
//|
//| def __init__(self, pin: microcontroller.Pin, maxlen: int = 2, *, idle_state: bool = False):
//| """Create a PulseIn object associated with the given pin. The object acts as
diff --git a/shared-bindings/pulseio/PulseOut.c b/shared-bindings/pulseio/PulseOut.c
index 9c650731b..16b0a6f0c 100644
--- a/shared-bindings/pulseio/PulseOut.c
+++ b/shared-bindings/pulseio/PulseOut.c
@@ -37,14 +37,9 @@
#include "supervisor/shared/translate.h"
//| class PulseOut:
-//| """.. currentmodule:: pulseio
-//|
-//| :class:`PulseOut` -- Output a pulse train
-//| ========================================================
-//|
-//| PulseOut is used to pulse PWM "carrier" output on and off. This is commonly
-//| used in infrared remotes. The pulsed signal consists of timed on and off
-//| periods. Unlike PWM, there is no set duration for on and off pairs."""
+//| """Pulse PWM "carrier" output on and off. This is commonly used in infrared remotes. The
+//| pulsed signal consists of timed on and off periods. Unlike PWM, there is no set duration
+//| for on and off pairs."""
//|
//| def __init__(self, carrier: pulseio.PWMOut):
//| """Create a PulseOut object associated with the given PWMout object.
@@ -115,7 +110,7 @@ STATIC mp_obj_t pulseio_pulseout_obj___exit__(size_t n_args, const mp_obj_t *arg
}
STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(pulseio_pulseout___exit___obj, 4, 4, pulseio_pulseout_obj___exit__);
-//| def send(self, pulses: array.array) -> Any:
+//| def send(self, pulses: array.array) -> Any:
//| """Pulse alternating on and off durations in microseconds starting with on.
//| ``pulses`` must be an `array.array` with data type 'H' for unsigned
//| halfword (two bytes).
diff --git a/shared-bindings/pulseio/__init__.c b/shared-bindings/pulseio/__init__.c
index 70cb61fc3..87946e5f0 100644
--- a/shared-bindings/pulseio/__init__.c
+++ b/shared-bindings/pulseio/__init__.c
@@ -35,24 +35,10 @@
#include "shared-bindings/pulseio/PulseOut.h"
#include "shared-bindings/pulseio/PWMOut.h"
-//| """:mod:`pulseio` --- Support for pulse based protocols
-//| =====================================================
-//|
-//| .. module:: pulseio
-//| :synopsis: Support for pulse based protocols
-//| :platform: SAMD21, ESP8266
+//| """Support for pulse based protocols
//|
//| The `pulseio` module contains classes to provide access to basic pulse IO.
//|
-//| Libraries
-//|
-//| .. toctree::
-//| :maxdepth: 3
-//|
-//| PulseIn
-//| PulseOut
-//| PWMOut
-//|
//| All classes change hardware state and should be deinitialized when they
//| are no longer needed if the program continues after use. To do so, either