Remoteit 1.0.2
dotnet add package Remoteit --version 1.0.2
NuGet\Install-Package Remoteit -Version 1.0.2
<PackageReference Include="Remoteit" Version="1.0.2" />
paket add Remoteit --version 1.0.2
#r "nuget: Remoteit, 1.0.2"
// Install Remoteit as a Cake Addin
#addin nuget:?package=Remoteit&version=1.0.2
// Install Remoteit as a Cake Tool
#tool nuget:?package=Remoteit&version=1.0.2
remoteit-csharp
remoteit-csharp is an open-source C# client for the remote.it REST API. With this package, you can programmatically list and securely connect to your remote.it devices. This client is distributed as a NuGet package targeting the .NET Core framework.
Anyone is welcome to contribute to this project. Feel free to make any issues and pull-requests.
Installation
Using the .NET Core Command Line Tools
If you are building with the .NET Core command-line tools, you can run the following command from within your project directory:
dotnet add package Remoteit
Using Visual Studio IDE
From within Visual Studio, you can use the NuGet GUI to search for and install the Remoteit NuGet package. Alternatively, you can use the built-in package manager console and write the following command.
Install-Package Twilio
Usage
Authentication
var remoteitUsername = Environment.GetEnvironmentVariable("REMOTEIT_USERNAME");
var remoteitPassword = Environment.GetEnvironmentVariable("REMOTEIT_PASSWORD");
var remoteitDevKey = Environment.GetEnvironmentVariable("REMOTEIT_DEVELOPER_KEY");
var remoteitClient = new RemoteitClient(remoteitUsername, remoteitPassword, remoteitDevKey);
After authenticating, you can list your devices, connect to them, and terminate device connections.
Listing Your Devices
var remoteitClient = new RemoteitClient(remoteitUsername, remoteitPassword, remoteitDevKey);
List<RemoteitDevice> devices = await remoteitClient.GetDevices();
Connecting to a Device
var remoteitClient = new RemoteitClient(remoteitUsername, remoteitPassword, remoteitDevKey);
var deviceAddress = "80:00:00:00:01:XX:XX:XX";
// Create a device connection
ServiceConnection connectionData = await remoteitClient.ConnectToService(deviceAddress);
// Example: https://XXXasnap.p18.rt3.io/
string connectionUrl = connectionData.Proxy;
Terminating a Device Connection
var remoteitClient = new RemoteitClient(remoteitUsername, remoteitPassword, remoteitDevKey);
string deviceAddress = "80:00:00:00:01:XX:XX:XX";
// Create a device connection
ServiceConnection connectionData = await remoteitClient.ConnectToService(deviceAddress);
// Get the connection's ID from the service connection object.
string connectionId = connectionData.ConnectionId;
// Terminate the connection. An exception is thrown if the termination is unsucesful.
await remoteitClient.TerminateDeviceConnection(deviceAddress, connectionId);
Development
Dependencies
You can install the project's dependencies by running dotnet restore
in the project root.
Testing
All tests are located in the Remoteit.Test
project. The testing libraries used for this project are xUnit and Moq.
Continues integration is done through Azure Pipelines. The azure-pipelines.yml
file configures this pipeline. Pipeline Link
Authors
- Kyle O'Brien - Initial work - LinkedIn
License
This project is licensed under the MIT License - see the LICENSE.md file for details
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp3.1 is compatible. |
-
.NETCoreApp 3.1
- No dependencies.
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.2 | 481 | 5/24/2020 |