library: first implementation of the Digi XBee C# Library

The original project has been split in two modules:

- XBeeLibrary.Core: contains all the common code for any platform.
- XBeeLibrary.Xamarin: contains the necessary APIs to develop
  cross-platform mobile applications with Xamarin to communicate with XBee
  devices over Bluetooth Low Energy.

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

Author: rubenmoral

.gitignore

@@ -2,3 +2,5 @@
 **/bin
 **/*.csproj.user
 **/*.suo
+.vs/
+packages/

CONTRIBUTING.md

@@ -0,0 +1,44 @@
+# How to Contribute
+
+## Getting help
+
+To ask questions about the XBee C# 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/xbee-csharp/issues).
+Before reporting a bug, please read the following points:
+
+1. Make sure that it is really a bug by checking the 
+[documentation](https://www.digi.com/resources/documentation/digidocs/90002359/).
+2. 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/xbee-csharp/issues).
+3. 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
+
+1. Consult the [documentation](https://www.digi.com/resources/documentation/digidocs/90002359/) 
+to ensure that the behavior you would like is not excluded.
+2. Make sure someone has not already requested it. See the list of 
+[known issues](http://github.com/digidotcom/xbee-csharp/issues).
+3. Submit your request in the issue tracker.
+
+
+## Contributing code
+
+1. Fork the [XBee C# Library](http://github.com/digidotcom/xbee-csharp) 
+repository ([how to fork a repo](https://help.github.com/articles/fork-a-repo/)).
+2. Create a branch for your contribution. Use a name that defines the purpose of the additions/modifications. 
+3. Make your changes following the code style used in the library.
+4. 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.

README.md

@@ -1,17 +1,27 @@
-XBee C# Library
-=================
+# XBee C# Library [ ![NuGet](https://img.shields.io/nuget/v/XBeeLibrary.Core)](https://www.nuget.org/packages/XBeeLibrary.Core/) [ ![NuGet](https://img.shields.io/nuget/v/XBeeLibrary.Xamarin)](https://www.nuget.org/packages/XBeeLibrary.Xamarin/)
 
 This project contains the source code of the XBee C# Library, an easy-to-use 
 API developed in C# that allows you to interact with Digi International's
-[XBee](http://www.digi.com/xbee/) radio frequency (RF) modules.
+[XBee](http://www.digi.com/xbee/) radio frequency (RF) modules. This source has 
+been contributed by [Digi International](http://www.digi.com) from the original
+work of Sébastien Rault.
 
-This source has been converted from the Java version provided by [Digi International](http://www.digi.com).
+The XBee C# library has two modules: **XBeeLibrary.Core**, which contains all
+the common code for any platform, and **XBeeLibrary.Xamarin**, which contains
+the necessary APIs to develop multi-platform mobile applications with Xamarin
+to communicate with XBee devices over Bluetooth Low Energy.
+
+The project includes the C# source code and multiple examples that show how to
+use the available APIs. The examples are also available in source code format.
 
 The main features of the library include:
 
-* Support for ZigBee, 802.15.4, DigiMesh and Point-to-Multipoint XBee devices.
+* Support for ZigBee, 802.15.4, DigiMesh, Point-to-Multipoint and Cellular
+XBee devices.
 * Support for API and API escaped operating modes.
-* Management of local (attached to the PC) and remote XBee device objects.
+* Support for communicating with XBee devices over Bluetooth Low Energy
+(XBeeLibrary.Xamarin).
+* Management of local (attached to the host) 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:
@@ -26,6 +36,7 @@ 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.
@@ -34,11 +45,36 @@ device.
   * 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).
+* Support for User Data Relay frames, allowing the communication between
+different interfaces (Serial, Bluetooth Low Energy and MicroPython).
+
+
+## Start Here
+
+The best place to get started is the 
+[XBee C# Library documentation](http://www.digi.com/resources/documentation/digidocs/90002359/).
+
 
-License
--------
-This software is open-source software. Copyright Sébastien RAULT, 2014-2015. 
+## How to Contribute
+
+The contributing guidelines are in the 
+[CONTRIBUTING.md](https://github.com/digidotcom/xbee-csharp/blob/master/CONTRIBUTING.md) 
+document.
+
+
+## License
+
+Copyright 2019, Digi International Inc.
+Copyright 2014-2015, Sébastien RAULT. 
 
 This Source Code Form is subject to the terms of the Mozilla Public
-License, v. 2.0. If a copy of the MPL was not distributed with this file,
-you can obtain one at http://mozilla.org/MPL/2.0/.
+License, v. 2.0. If a copy of the MPL was not distributed with this
+file, you can obtain one at http://mozilla.org/MPL/2.0/.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.