Helium / helium

An mbed wrapper around the helium-client to communicate with the Helium Atom

Helium for ARM mbed

This code repository exposes an mbed library for the Helium Atom module. The Helium Atom makes it easy to securely connect IoT devices and applications to back-end IoT services.

Getting Started

See a getting started guide on the Helium site.

Supported Boards

The Helium mbed client should work with any mbed board with an available serial port.

Example Setup

Example applications can be found in the mbed Helium team.

Getting Help

If you have any questions or ideas about how to use this code - or any part of Helium - head over to the Helium Community Slack. We're standing by to help.

Contributing

Want to contribute to helium-mbed? That's awesome!

Please see CONTRIBUTING.md in this repository for details.

Diff: src/Helium.h

Revision:
18:c735140666d1
Parent:
17:f38730193da3
Child:
19:be9553194a4e
--- a/src/Helium.h	Fri Jul 07 21:34:49 2017 -0700
+++ b/src/Helium.h	Mon Jul 10 13:22:06 2017 -0700
@@ -64,8 +64,6 @@
      * @param retries The number of retries to attempt to connect.
      *
      * @return helium_connect_status
-     *
-     * @see Helium#connect()
      */
     int connect(struct connection * connection = NULL,
                 uint32_t            retries    = HELIUM_POLL_RETRIES_5S);
@@ -86,11 +84,16 @@
      * call to quick connect to the network.
      *
      * @param connection Sleep connection buffer to fill in.
-     *
-     * @see Helium::sleep() for the easy version.
      */
     int sleep(struct connection * connection = NULL);
 
+    /** Resets the Atom.
+     *
+     * This resets the Atom. Use this method when `needs_reset`
+     * returns true to apply any pending firmware updates to the Atom.
+     */
+    int reset();
+
 
   private:
     struct helium_ctx _ctx;