feat(CUB-39): create background job for filament usage sync
This commit is contained in:
19
backend/Domain/Interfaces/IFilamentUsageSyncService.cs
Normal file
19
backend/Domain/Interfaces/IFilamentUsageSyncService.cs
Normal file
@@ -0,0 +1,19 @@
|
||||
namespace Extrudex.Domain.Interfaces;
|
||||
|
||||
/// <summary>
|
||||
/// Service interface for syncing filament usage data from printers
|
||||
/// into the Extrudex database. Handles querying Moonraker printers,
|
||||
/// computing derived usage metrics, and persisting updates to spools
|
||||
/// and print job records.
|
||||
/// </summary>
|
||||
public interface IFilamentUsageSyncService
|
||||
{
|
||||
/// <summary>
|
||||
/// Performs a single sync cycle: queries all active Moonraker printers,
|
||||
/// fetches their current filament usage data, and persists updates to
|
||||
/// the database.
|
||||
/// </summary>
|
||||
/// <param name="cancellationToken">Cancellation token for graceful shutdown.</param>
|
||||
/// <returns>The number of printers successfully synced.</returns>
|
||||
Task<int> SyncAllAsync(CancellationToken cancellationToken = default);
|
||||
}
|
||||
39
backend/Domain/Interfaces/IMoonrakerClient.cs
Normal file
39
backend/Domain/Interfaces/IMoonrakerClient.cs
Normal file
@@ -0,0 +1,39 @@
|
||||
namespace Extrudex.Domain.Interfaces;
|
||||
|
||||
/// <summary>
|
||||
/// Client interface for communicating with Moonraker REST API endpoints
|
||||
/// on Klipper-based printers (e.g., Elegoo Centauri Carbon).
|
||||
/// Used to retrieve filament usage data, print job status, and
|
||||
/// remaining spool weight from the printer.
|
||||
/// </summary>
|
||||
public interface IMoonrakerClient
|
||||
{
|
||||
/// <summary>
|
||||
/// Fetches the current filament usage data from the Moonraker server.
|
||||
/// Returns a dictionary of usage metrics reported by the printer.
|
||||
/// </summary>
|
||||
/// <param name="hostnameOrIp">The printer's hostname or IP address.</param>
|
||||
/// <param name="port">The Moonraker API port (default: 7125).</param>
|
||||
/// <param name="apiKey">Optional API key for authentication.</param>
|
||||
/// <param name="cancellationToken">Cancellation token for the HTTP request.</param>
|
||||
/// <returns>A dictionary of usage metric names to their decimal values.</returns>
|
||||
Task<Dictionary<string, decimal>> GetFilamentUsageAsync(
|
||||
string hostnameOrIp,
|
||||
int port,
|
||||
string? apiKey,
|
||||
CancellationToken cancellationToken = default);
|
||||
|
||||
/// <summary>
|
||||
/// Checks whether the Moonraker server is reachable and responding.
|
||||
/// </summary>
|
||||
/// <param name="hostnameOrIp">The printer's hostname or IP address.</param>
|
||||
/// <param name="port">The Moonraker API port (default: 7125).</param>
|
||||
/// <param name="apiKey">Optional API key for authentication.</param>
|
||||
/// <param name="cancellationToken">Cancellation token for the HTTP request.</param>
|
||||
/// <returns><c>true</c> if the server responded successfully; otherwise <c>false</c>.</returns>
|
||||
Task<bool> IsReachableAsync(
|
||||
string hostnameOrIp,
|
||||
int port,
|
||||
string? apiKey,
|
||||
CancellationToken cancellationToken = default);
|
||||
}
|
||||
Reference in New Issue
Block a user