diff options
| -rw-r--r-- | shared-bindings/analogio/AnalogIn.c | 62 | ||||
| -rw-r--r-- | shared-bindings/analogio/AnalogOut.c | 57 |
2 files changed, 59 insertions, 60 deletions
diff --git a/shared-bindings/analogio/AnalogIn.c b/shared-bindings/analogio/AnalogIn.c index a8afe75bd..9b6ac086b 100644 --- a/shared-bindings/analogio/AnalogIn.c +++ b/shared-bindings/analogio/AnalogIn.c @@ -37,24 +37,24 @@ #include "shared-bindings/util.h" //|class AnalogIn: -//| """:class:`AnalogIn` -- read analog voltage -//| ============================================ +//|""":class:`AnalogIn` -- read analog voltage +//|============================================ //| -//| Usage:: +//|Usage:: //| -//| import analogio -//| from board import * +//|import analogio +//|from board import * //| -//| adc = analogio.AnalogIn(A1) -//| val = adc.value""" +//|adc = analogio.AnalogIn(A1) +//|val = adc.value""" //| -//| def __init__(self, pin: microcontroller.Pin): +//|def __init__(self, pin: microcontroller.Pin): //| -//| """Use the AnalogIn on the given pin. The reference voltage varies by -//| platform so use ``reference_voltage`` to read the configured setting. +//|"""Use the AnalogIn on the given pin. The reference voltage varies by +//|platform so use ``reference_voltage`` to read the configured setting. //| -//| :param ~microcontroller.Pin pin: the pin to read from""" -//| ... +//|:param ~microcontroller.Pin pin: the pin to read from""" +//|... STATIC mp_obj_t analogio_analogin_make_new(const mp_obj_type_t *type, mp_uint_t n_args, const mp_obj_t *args, mp_map_t *kw_args) { // check number of arguments @@ -70,9 +70,9 @@ STATIC mp_obj_t analogio_analogin_make_new(const mp_obj_type_t *type, return MP_OBJ_FROM_PTR(self); } -//| def deinit(self, ) -> Any: -//| """Turn off the AnalogIn and release the pin for other use.""" -//| ... +//|def deinit(self, ) -> Any: +//|"""Turn off the AnalogIn and release the pin for other use.""" +//|... STATIC mp_obj_t analogio_analogin_deinit(mp_obj_t self_in) { analogio_analogin_obj_t *self = MP_OBJ_TO_PTR(self_in); common_hal_analogio_analogin_deinit(self); @@ -85,15 +85,15 @@ STATIC void check_for_deinit(analogio_analogin_obj_t *self) { raise_deinited_error(); } } -//| def __enter__(self, ) -> Any: -//| """No-op used by Context Managers.""" -//| ... +//|def __enter__(self, ) -> Any: +//|"""No-op used by Context Managers.""" +//|... // Provided by context manager helper. -//| def __exit__(self, ) -> Any: -//| """Automatically deinitializes the hardware when exiting a context. See -//| :ref:`lifetime-and-contextmanagers` for more info.""" -//| ... +//|def __exit__(self, ) -> Any: +//|"Automatically deinitializes the hardware when exiting a context. See +//|:ref:`lifetime-and-contextmanagers` for more info.""" +//|... STATIC mp_obj_t analogio_analogin___exit__(size_t n_args, const mp_obj_t *args) { (void)n_args; common_hal_analogio_analogin_deinit(args[0]); @@ -101,12 +101,12 @@ STATIC mp_obj_t analogio_analogin___exit__(size_t n_args, const mp_obj_t *args) } STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(analogio_analogin___exit___obj, 4, 4, analogio_analogin___exit__); -//| value: Any = -//| """The value on the analog pin between 0 and 65535 inclusive (16-bit). (read-only) +//|value: Any = +//|"""The value on the analog pin between 0 and 65535 inclusive (16-bit). (read-only) //| -//| Even if the underlying analog to digital converter (ADC) is lower -//| resolution, the value is 16-bit.""" -//| ... +//|Even if the underlying analog to digital converter (ADC) is lower +//|resolution, the value is 16-bit.""" +//|... STATIC mp_obj_t analogio_analogin_obj_get_value(mp_obj_t self_in) { analogio_analogin_obj_t *self = MP_OBJ_TO_PTR(self_in); check_for_deinit(self); @@ -121,10 +121,10 @@ const mp_obj_property_t analogio_analogin_value_obj = { (mp_obj_t)&mp_const_none_obj}, }; -//| reference_voltage: Any = -//| """The maximum voltage measurable (also known as the reference voltage) as a -//| `float` in Volts.""" -//| ... +//|reference_voltage: Any = +//|"""The maximum voltage measurable (also known as the reference voltage) as a +//|`float` in Volts.""" +//|... STATIC mp_obj_t analogio_analogin_obj_get_reference_voltage(mp_obj_t self_in) { analogio_analogin_obj_t *self = MP_OBJ_TO_PTR(self_in); check_for_deinit(self); diff --git a/shared-bindings/analogio/AnalogOut.c b/shared-bindings/analogio/AnalogOut.c index 1b5808e6c..231668290 100644 --- a/shared-bindings/analogio/AnalogOut.c +++ b/shared-bindings/analogio/AnalogOut.c @@ -37,26 +37,25 @@ #include "supervisor/shared/translate.h" //|class AnalogOut: -//| """.. currentmodule:: analogio +//|""".. currentmodule:: analogio //| -//| :class:`AnalogOut` -- output analog voltage -//| ============================================ +//|:class:`AnalogOut` -- output analog voltage +//|============================================ //| -//| The AnalogOut is used to output analog values (a specific voltage). +//|The AnalogOut is used to output analog values (a specific voltage). //| -//| Example usage:: +//|Example usage:: //| -//| import analogio -//| from microcontroller import pin +//|import analogio +//|from microcontroller import pin //| -//| dac = analogio.AnalogOut(pin.PA02) # output on pin PA02 -//| dac.value = 32768 # makes PA02 1.65V""" -//| def __init__(self, pin: microcontroller.Pin): +//|dac = analogio.AnalogOut(pin.PA02) # output on pin PA02 +//|dac.value = 32768 # makes PA02 1.65V""" +//|def __init__(self, pin: microcontroller.Pin): +//|"""Use the AnalogOut on the given pin. //| -//| """Use the AnalogOut on the given pin. -//| -//| :param ~microcontroller.Pin pin: the pin to output to""" -//| ... +//|:param ~microcontroller.Pin pin: the pin to output to""" +//|... STATIC mp_obj_t analogio_analogout_make_new(const mp_obj_type_t *type, mp_uint_t n_args, const mp_obj_t *args, mp_map_t *kw_args) { // check arguments mp_arg_check_num(n_args, kw_args, 1, 1, false); @@ -70,9 +69,9 @@ STATIC mp_obj_t analogio_analogout_make_new(const mp_obj_type_t *type, mp_uint_t return MP_OBJ_FROM_PTR(self); } -//| def deinit(self, ) -> Any: -//| """Turn off the AnalogOut and release the pin for other use.""" -//| ... +//|def deinit(self, ) -> Any: +//|"""Turn off the AnalogOut and release the pin for other use.""" +//|... STATIC mp_obj_t analogio_analogout_deinit(mp_obj_t self_in) { analogio_analogout_obj_t *self = self_in; @@ -82,15 +81,15 @@ STATIC mp_obj_t analogio_analogout_deinit(mp_obj_t self_in) { } STATIC MP_DEFINE_CONST_FUN_OBJ_1(analogio_analogout_deinit_obj, analogio_analogout_deinit); -//| def __enter__(self, ) -> Any: -//| """No-op used by Context Managers.""" -//| ... +//|def __enter__(self, ) -> Any: +//|"""No-op used by Context Managers.""" +//|... // Provided by context manager helper. -//| def __exit__(self, ) -> Any: -//| """Automatically deinitializes the hardware when exiting a context. See -//| :ref:`lifetime-and-contextmanagers` for more info.""" -//| ... +//|def __exit__(self, ) -> Any: +//|"""Automatically deinitializes the hardware when exiting a context. See +//|:ref:`lifetime-and-contextmanagers` for more info.""" +//|... STATIC mp_obj_t analogio_analogout___exit__(size_t n_args, const mp_obj_t *args) { (void)n_args; common_hal_analogio_analogout_deinit(args[0]); @@ -98,12 +97,12 @@ STATIC mp_obj_t analogio_analogout___exit__(size_t n_args, const mp_obj_t *args) } STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(analogio_analogout___exit___obj, 4, 4, analogio_analogout___exit__); -//| value: Any = -//| """The value on the analog pin between 0 and 65535 inclusive (16-bit). (write-only) +//|value: Any = +//|"""The value on the analog pin between 0 and 65535 inclusive (16-bit). (write-only) //| -//| Even if the underlying digital to analog converter (DAC) is lower -//| resolution, the value is 16-bit.""" -//| ... +//|Even if the underlying digital to analog converter (DAC) is lower +//|resolution, the value is 16-bit.""" +//|... STATIC mp_obj_t analogio_analogout_obj_set_value(mp_obj_t self_in, mp_obj_t value) { analogio_analogout_obj_t *self = MP_OBJ_TO_PTR(self_in); if (common_hal_analogio_analogout_deinited(self)) { |