DigiIoT.Maui 1.0.0

There is a newer version of this package available.
See the version list below for details.

dotnet add package DigiIoT.Maui --version 1.0.0

NuGet\Install-Package DigiIoT.Maui -Version 1.0.0

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="DigiIoT.Maui" Version="1.0.0" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add DigiIoT.Maui --version 1.0.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: DigiIoT.Maui, 1.0.0"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

// Install DigiIoT.Maui as a Cake Addin
#addin nuget:?package=DigiIoT.Maui&version=1.0.0

// Install DigiIoT.Maui as a Cake Tool
#tool nuget:?package=DigiIoT.Maui&version=1.0.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Digi IoT Library for .NET MAUI

This project contains the source code of the Digi IoT Library for .NET MAUI, an easy-to-use API developed in C# that simplifies the development of cross-platform mobile applications in .NET MAUI that communicate with Digi IoT devices over Bluetooth Low Energy. Among the compatible Digi IoT devices you can find the ConnectCore radio frequency (RF) modules and the XBee ones.

The XBee Digi IoT Library for .NET MAUI has one main module: DigiIoT.Maui, which contains the necessary APIs to develop cross-platform mobile applications in .NET MAUI.

The project includes the C# source code and some 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:

Supported hardware:
- Digi ConnectCore devices.
- Digi XBee 3 devices:
  - XBee 3 Zigbee
  - XBee 3 802.15.4
  - XBee 3 DigiMesh
  - XBee 3 Cellular
Support for communicating with the supported hardware over Bluetooth Low Energy:
- Connect
- Disconnect
- Send data
- Receive data (directly or through events)
Bluetooth Low Energy specific functionality:
- Automatic Bluetooth permissions request handling for Android and iOS
- Custom Bluetooth event delegates to be notified about changes in the interface
- Bluetooth scan functionality to look for BLE devices and get notified when they are discovered
XBee specific functionality:
- 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.
- Support for User Data Relay frames, allowing the communication between different interfaces (Serial and MicroPython).
- IO lines management:
  - Configure IO lines.
  - Set IO line value.
  - Read IO line value.

Start Here

The best place to get started is the Digi IoT Library for .NET MAUI User Guide.

How to Contribute

The contributing guidelines are in the CONTRIBUTING.md document.

License

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/.

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.

Product	Compatible and additional computed target framework versions.
.NET	net7.0-android33.0 is compatible. net7.0-ios16.1 is compatible. net7.0-windows10.0.19041 is compatible. net8.0-android was computed. net8.0-ios was computed. net8.0-windows was computed.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net7.0-android33.0
- Plugin.BLE (>= 3.0.0-beta.3)
- XBeeLibrary.Core (>= 1.0.3)
net7.0-ios16.1
- Plugin.BLE (>= 3.0.0-beta.3)
- XBeeLibrary.Core (>= 1.0.3)
net7.0-windows10.0.19041
- Plugin.BLE (>= 3.0.0-beta.3)
- XBeeLibrary.Core (>= 1.0.3)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last updated
1.0.1	275	5/21/2024
1.0.0	137	9/15/2023

Digi IoT Library for .NET MAUI
                                 DigiIoT.Maui

                        Release Notes (PN 93001378_A)
                                 Build 1.0.0
                             14 September, 2023

                   Copyright 2023, Digi International Inc.
                             http://www.digi.com/

Introduction
-------------------------------------------------------------------------------

This document provides the latest release information for the Digi IoT Library
for .NET MAUI, which allows customers to easily develop cross-platform mobile
applications in .NET MAUI that communicate with Digi IoT devices over
Bluetooth Low Energy.

Digi IoT Library for .NET MAUI v1.0.0, September 2023
-------------------------------------------------------------------------------
1. Supported Hardware:
     * Digi ConnectCore devices.
     * Digi XBee 3 devices:
       * XBee 3 Zigbee
       * XBee 3 802.15.4
       * XBee 3 DigiMesh
       * XBee 3 Cellular

2. Changes with respect to previous version:
     * Support for communicating with the supported hardware over Bluetooth
       Low Energy:
       * Connect
       * Disconnect
       * Send data
       * Receive data (directly or through events)

     * XBee specific functionality:
       * 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.
       * Support for User Data Relay frames, allowing the communication
         between different interfaces (Serial and MicroPython).
       * IO lines management:
         * Configure IO lines.
         * Set IO line value.
         * Read IO line value.

     * Bluetooth Low Energy specific functionality:
       * Automatic Bluetooth permissions request handling for Android and iOS
       * Custom Bluetooth event delegates to be notified about changes in the
         interface
       * Bluetooth scan functionality to look for BLE devices and get notified
         when they are discovered

     * Maui application examples demonstrating some API specific features.
       * Communicate with ConnectCore devices over Bluetooth Low Energy.
       * Configure XBee devices over Bluetooth Low Energy.
       * Send and receive data over Bluetooth Low Energy to a micro-controller
         connected to the XBee serial interface.
       * Send and receive data over Bluetooth Low Energy to the MicroPython
application running in the XBee deivce.

     * Comprehensive online documentation including:
       * Getting Started Guide.
       * Users Guide.
       * API Reference Manual.

3. Known Issues and Limitations:
     * N/A