Add PulseOut which can pulse a PWMOut for IR remote transmission.

3 files changed, 194 insertions, 0 deletions

diff --git a/shared-bindings/nativeio/PulseOut.c b/shared-bindings/nativeio/PulseOut.c
new file mode 100644
index 000000000..013e0851a
--- /dev/null
+++ b/shared-bindings/nativeio/PulseOut.c
@@ -0,0 +1,150 @@
+/*
+ * This file is part of the Micro Python project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2016 Damien P. George
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#include <stdint.h>
+
+#include "lib/utils/context_manager_helpers.h"
+#include "py/objproperty.h"
+#include "py/runtime.h"
+#include "shared-bindings/microcontroller/Pin.h"
+#include "shared-bindings/nativeio/PulseOut.h"
+#include "shared-bindings/nativeio/PWMOut.h"
+
+//| .. currentmodule:: nativeio
+//|
+//| :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.
+//|
+//| .. class:: PulseOut(carrier)
+//|
+//|   Create a PulseOut object associated with the given PWM out experience.
+//|
+//|   :param ~nativeio.PWMOut carrier: PWMOut that is set to output on the desired pin.
+//|
+//|   Send a short series of pulses::
+//|
+//|     import array
+//|     import nativeio
+//|     import board
+//|
+//|     with nativeio.PWMOut(board.D13, duty_cycle=2 ** 15) as pwm:
+//|         pulse = nativeio.PulseOut(pwm)
+//|         #                             on   off     on     off   on
+//|         pulses = array.array('h', [65000, 1000, 65000, 65000, 1000])
+//|         pulse.send(pulses)
+//|
+//|         # Modify the array of pulses.
+//|         pulses[0] = 200
+//|         pulse.send(pulses)
+//|
+STATIC mp_obj_t nativeio_pulseout_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *args) {
+    mp_arg_check_num(n_args, n_kw, 1, 1, true);
+    mp_obj_t carrier_obj = args[0];
+
+    if (!MP_OBJ_IS_TYPE(carrier_obj, &nativeio_pwmout_type)) {
+        nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_TypeError, "Expected a %q", nativeio_pwmout_type.name));
+    }
+
+    // create Pulse object from the given pin
+    nativeio_pulseout_obj_t *self = m_new_obj(nativeio_pulseout_obj_t);
+    self->base.type = &nativeio_pulseout_type;
+
+    common_hal_nativeio_pulseout_construct(self, (nativeio_pwmout_obj_t *)MP_OBJ_TO_PTR(carrier_obj));
+
+    return MP_OBJ_FROM_PTR(self);
+}
+
+//|   .. method:: deinit()
+//|
+//|      Deinitialises the PulseOut and releases any hardware resources for reuse.
+//|
+STATIC mp_obj_t nativeio_pulseout_deinit(mp_obj_t self_in) {
+    nativeio_pulseout_obj_t *self = MP_OBJ_TO_PTR(self_in);
+    common_hal_nativeio_pulseout_deinit(self);
+    return mp_const_none;
+}
+STATIC MP_DEFINE_CONST_FUN_OBJ_1(nativeio_pulseout_deinit_obj, nativeio_pulseout_deinit);
+
+//|   .. method:: __enter__()
+//|
+//|      No-op used by Context Managers.
+//|
+//  Provided by context manager helper.
+
+//|   .. method:: __exit__()
+//|
+//|      Automatically deinitializes the hardware when exiting a context.
+//|
+STATIC mp_obj_t nativeio_pulseout_obj___exit__(size_t n_args, const mp_obj_t *args) {
+    (void)n_args;
+    common_hal_nativeio_pulseout_deinit(args[0]);
+    return mp_const_none;
+}
+STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(nativeio_pulseout___exit___obj, 4, 4, nativeio_pulseout_obj___exit__);
+
+//|   .. method:: send(pulses)
+//|
+//|     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).
+//|
+//|     This method waits until the whole array of pulses has been sent and
+//|     ensures the signal is off afterwards.
+//|
+//|     :param array.array pulses: pulse durations in microseconds
+//|
+STATIC mp_obj_t nativeio_pulseout_obj_send(mp_obj_t self_in, mp_obj_t pulses) {
+    nativeio_pulseout_obj_t *self = MP_OBJ_TO_PTR(self_in);
+
+    mp_buffer_info_t bufinfo;
+    mp_get_buffer_raise(pulses, &bufinfo, MP_BUFFER_READ);
+    if (bufinfo.typecode != 'H') {
+        mp_raise_TypeError("Array must contain halfwords (type 'H')");
+    }
+    common_hal_nativeio_pulseout_send(self, (uint16_t *)bufinfo.buf, bufinfo.len / 2);
+    return mp_const_none;
+}
+MP_DEFINE_CONST_FUN_OBJ_2(nativeio_pulseout_send_obj, nativeio_pulseout_obj_send);
+
+STATIC const mp_rom_map_elem_t nativeio_pulseout_locals_dict_table[] = {
+    // Methods
+    { MP_ROM_QSTR(MP_QSTR_deinit), MP_ROM_PTR(&nativeio_pulseout_deinit_obj) },
+    { MP_ROM_QSTR(MP_QSTR___enter__), MP_ROM_PTR(&default___enter___obj) },
+    { MP_ROM_QSTR(MP_QSTR___exit__), MP_ROM_PTR(&nativeio_pulseout___exit___obj) },
+    { MP_ROM_QSTR(MP_QSTR_send), MP_ROM_PTR(&nativeio_pulseout_send_obj) },
+};
+STATIC MP_DEFINE_CONST_DICT(nativeio_pulseout_locals_dict, nativeio_pulseout_locals_dict_table);
+
+const mp_obj_type_t nativeio_pulseout_type = {
+    { &mp_type_type },
+    .name = MP_QSTR_PulseOut,
+    .make_new = nativeio_pulseout_make_new,
+    .locals_dict = (mp_obj_dict_t*)&nativeio_pulseout_locals_dict,
+};
diff --git a/shared-bindings/nativeio/PulseOut.h b/shared-bindings/nativeio/PulseOut.h
new file mode 100644
index 000000000..23fb8efed
--- /dev/null
+++ b/shared-bindings/nativeio/PulseOut.h
@@ -0,0 +1,41 @@
+/*
+ * This file is part of the Micro Python project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2013, 2014 Damien P. George
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#ifndef __MICROPY_INCLUDED_SHARED_BINDINGS_NATIVEIO_PULSEOUT_H__
+#define __MICROPY_INCLUDED_SHARED_BINDINGS_NATIVEIO_PULSEOUT_H__
+
+#include "common-hal/microcontroller/types.h"
+#include "common-hal/nativeio/types.h"
+
+extern const mp_obj_type_t nativeio_pulseout_type;
+
+extern void common_hal_nativeio_pulseout_construct(nativeio_pulseout_obj_t* self,
+    const nativeio_pwmout_obj_t* carrier);
+extern void common_hal_nativeio_pulseout_deinit(nativeio_pulseout_obj_t* self);
+extern void common_hal_nativeio_pulseout_send(nativeio_pulseout_obj_t* self,
+    uint16_t* pulses, uint16_t len);
+
+#endif // __MICROPY_INCLUDED_SHARED_BINDINGS_NATIVEIO_PULSEOUT_H__
diff --git a/shared-bindings/nativeio/__init__.c b/shared-bindings/nativeio/__init__.c
index 3d4b8c823..af3b5e84b 100644
--- a/shared-bindings/nativeio/__init__.c
+++ b/shared-bindings/nativeio/__init__.c
@@ -39,6 +39,7 @@
 #include "shared-bindings/nativeio/AnalogOut.h"
 #include "shared-bindings/nativeio/DigitalInOut.h"
 #include "shared-bindings/nativeio/I2C.h"
+#include "shared-bindings/nativeio/PulseOut.h"
 #include "shared-bindings/nativeio/PWMOut.h"
 #include "shared-bindings/nativeio/SPI.h"
 #include "shared-bindings/nativeio/TouchIn.h"
@@ -74,6 +75,7 @@
 //|     AnalogOut
 //|     DigitalInOut
 //|     I2C
+//|     PulseOut
 //|     PWMOut
 //|     SPI
 //|     TouchIn
@@ -116,6 +118,7 @@ STATIC const mp_rom_map_elem_t nativeio_module_globals_table[] = {
     { MP_ROM_QSTR(MP_QSTR_AnalogOut),   MP_ROM_PTR(&nativeio_analogout_type) },
     { MP_ROM_QSTR(MP_QSTR_DigitalInOut),  MP_ROM_PTR(&nativeio_digitalinout_type) },
     { MP_ROM_QSTR(MP_QSTR_I2C),   MP_ROM_PTR(&nativeio_i2c_type) },
+    { MP_ROM_QSTR(MP_QSTR_PulseOut), MP_ROM_PTR(&nativeio_pulseout_type) },
     { MP_ROM_QSTR(MP_QSTR_PWMOut), MP_ROM_PTR(&nativeio_pwmout_type) },
     { MP_ROM_QSTR(MP_QSTR_SPI),   MP_ROM_PTR(&nativeio_spi_type) },
     { MP_ROM_QSTR(MP_QSTR_TouchIn),   MP_ROM_PTR(&nativeio_touchin_type) },