OctoPrintSharpApi 1.1.3
See the version list below for details.
dotnet add package OctoPrintSharpApi --version 1.1.3
NuGet\Install-Package OctoPrintSharpApi -Version 1.1.3
<PackageReference Include="OctoPrintSharpApi" Version="1.1.3" />
paket add OctoPrintSharpApi --version 1.1.3
#r "nuget: OctoPrintSharpApi, 1.1.3"
// Install OctoPrintSharpApi as a Cake Addin #addin nuget:?package=OctoPrintSharpApi&version=1.1.3 // Install OctoPrintSharpApi as a Cake Tool #tool nuget:?package=OctoPrintSharpApi&version=1.1.3
OctoPrintRestApiSharp
A simple C# library to communicate with an OctoPrint server via REST-API.
Usage
You can find some usage examples in the TestProject of the source code.
Init a new server
Just create a new OctoPrintServer
object by passing the host, api, port and ssl connection type.
OctoPrintServer _server = new OctoPrintServer(_host, _api, _port, _ssl);
await _server.CheckOnlineAsync();
if (_server.IsOnline)
{
// Sets the first printer active
if (_server.ActivePrinter == null)
await _server.SetPrinterActiveAsync(0, true);
await _server.RefreshAllAsync();
Assert.IsTrue(_server.InitialDataFetched);
}
Since then, you can access all functions from the OctoPrintServer
object.
Instance
If you want to use the OctoPrintServer from different places, use the Instance
.
OctoPrintServer.Instance = new OctoPrintServer(_host, _api, _port, _ssl);
await OctoPrintServer.Instance.CheckOnlineAsync();
Aferwards you can use the OctoPrintServer.Instance property to access all functions through your project.
var files = await OctoPrintServer.Instance.GetAllFilesAsync("local");
Available methods
Please find the some usage examples for the methods below.
// Load all files from the Server
var files = await OctoPrintServer.Instance.GetAllFilesAsync("local");
// Get all printer profiles
var printers = await OctoPrintServer.Instance.GetAllPrinterProfilesAsync();
// Update heated bed temperature & read back the state
bool result = await OctoPrintServer.Instance.SetBedTemperatureAsync(25);
var state = await OctoPrintServer.Instance.GetCurrentBedStateAsync(true);
// Update extruder (tool0 or / and tool1) & read back the state
bool result = await _OctoPrintServer.Instance.SetToolTemperatureAsync(30);
var state = await OctoPrintServer.Instance.GetCurrentToolStateAsync(true);
var jobinfo = await OctoPrintServer.Instance.GetJobInfoAsync();
Dependencies
RCoreSharp: https://github.com/AndreasReitberger/CoreSharp
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.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.1 is compatible. |
.NET Framework | net472 is compatible. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETFramework 4.7.2
- Newtonsoft.Json (>= 13.0.1)
- RCoreSharp (>= 1.0.6)
- RestSharp (>= 106.15.0)
- System.Net.Http (>= 4.3.4)
- WebSocket4Net (>= 0.15.2)
-
.NETStandard 2.1
- Newtonsoft.Json (>= 13.0.1)
- RCoreSharp (>= 1.0.6)
- RestSharp (>= 106.15.0)
- System.Net.Http (>= 4.3.4)
- WebSocket4Net (>= 0.15.2)
NuGet packages (2)
Showing the top 2 NuGet packages that depend on OctoPrintSharpApi:
Package | Downloads |
---|---|
GcodeParserSharp
A simple C# Gcode parser to read gcodes and get out the filament volume and estimated print time. |
|
GcodeParserSharp.Maui
A simple C# Gcode parser to read gcodes and get out the filament volume and estimated print time. |
GitHub repositories
This package is not used by any popular GitHub repositories.