Initial commit

Signed-off-by: Diego Escalona <[email protected]>
Signed-off-by: Hector Gonzalez <[email protected]>
Signed-off-by: Ruben Moral <[email protected]>

Author: rubenmoral

.gitignore

@@ -0,0 +1,3 @@
+*.pyc
+/doc/_build
+.idea

CHANGELOG.rst

@@ -0,0 +1,37 @@
+Changelog
+=========
+
+v1.0.0 - 10/02/2017
+-------------------
+
+Initial release of XBee Python library. The main features of the library
+include:
+
+* Support for ZigBee, 802.15.4, DigiMesh, Point-to-Multipoint, Wi-Fi,
+  Cellular and NB-IoT devices.
+* Support for API and API escaped operating modes.
+* Management of local (attached to the PC) and remote XBee device objects.
+* Discovery of remote XBee devices associated with the same network as the
+  local device.
+* Configuration of local and remote XBee devices:
+  * Configure common parameters with specific setters and getters.
+  * Configure any other parameter with generic methods.
+  * Execute AT commands.
+  * Apply configuration changes.
+  * Write configuration changes.
+  * Reset the device.
+* Transmission of data to all the XBee devices on the network or to a
+  specific device.
+* Reception of data from remote XBee devices:
+  * Data polling.
+  * Data reception callback.
+* Transmission and reception of IP and SMS messages.
+* Reception of network status changes related to the local XBee device.
+* IO lines management:
+  * Configure IO lines.
+  * Set IO line value.
+  * Read IO line value.
+  * Receive IO data samples from any remote XBee device on the network.
+* Support for explicit frames and application layer fields (Source endpoint,
+  Destination endpoint, Profile ID, and Cluster ID).
+* Multiple examples that show how to use the available APIs.

CONTRIBUTING.rst

@@ -0,0 +1,57 @@
+How to Contribute
+=================
+
+
+Getting help
+------------
+
+To ask questions about the XBee Python library go to the
+`Digi Forum <http://www.digi.com/support/forum>`_.
+
+
+Reporting a bug
+---------------
+
+The way to report bugs is to use the
+`GitHub issue tracker <http://github.com/digidotcom/python-xbee/issues>`_.
+Before reporting a bug, please read the following points:
+
+#. Make sure that what you are seeing is really a bug by checking the
+   `documentation <https://xbplib.readthedocs.io/en/latest>`_ and consulting 
+   the `FAQs <https://xbplib.readthedocs.io/en/latest/faq.html>`_ section.
+#. If you still think you have found a bug, make sure someone has not already
+   reported it. See the list of
+   `known issues <http://github.com/digidotcom/python-xbee/issues>`_.
+#. If it has not been reported yet, create a new issue. Make sure to add enough
+   detail so that the bug can be reproduced.
+
+.. Note::
+   The issue tracker is for bugs, not requests for help. Questions
+   should be asked on the `Digi Forum <http://www.digi.com/support/forum>`_
+   instead.
+
+
+Suggesting a new feature
+------------------------
+
+#. Consult the `FAQs <https://xbplib.readthedocs.io/en/latest/faq.html>`_ 
+   section to ensure that the behavior you would like the library to have is 
+   not excluded.
+#. Make sure someone has not already requested it. See the list of
+   `known issues <http://github.com/digidotcom/python-xbee/issues>`_.
+#. Submit your request in the issue tracker.
+
+
+Contributing code
+-----------------
+
+#. Fork the `XBee Python library <http://github.com/digidotcom/python-xbee>`_
+   repository (`how to fork a repo
+   <https://help.github.com/articles/fork-a-repo/>`_).
+#. Create a branch for your contribution. Use a name that defines the purpose
+   of the additions/modifications.
+#. Make your changes following the code style used in the library.
+#. Submit a pull request (`how to create a pull request
+   <https://help.github.com/articles/fork-a-repo/#next-steps>`_). A project
+   developer will review your work and then merge your request into the
+   project, or come back to you with comments and/or questions.