Compare commits
1 Commits
agent/sket
...
agent/dex/
| Author | SHA1 | Date | |
|---|---|---|---|
| 6e0ca7f425 |
@@ -1,5 +1,6 @@
|
||||
using Extrudex.Domain.Interfaces;
|
||||
using Extrudex.Infrastructure.Configuration;
|
||||
using Microsoft.Extensions.DependencyInjection;
|
||||
using Microsoft.Extensions.Hosting;
|
||||
using Microsoft.Extensions.Logging;
|
||||
using Microsoft.Extensions.Options;
|
||||
@@ -15,25 +16,30 @@ namespace Extrudex.API.Jobs;
|
||||
/// Configuration is bound from the "FilamentUsageSync" section in
|
||||
/// appsettings.json. Set Enabled=false to disable without removing
|
||||
/// the service registration.
|
||||
///
|
||||
/// Uses an IServiceScopeFactory to resolve scoped dependencies
|
||||
/// (IFilamentUsageSyncService, IUsageLogService) on each sync cycle,
|
||||
/// avoiding captive-dependency issues from injecting scoped services
|
||||
/// into the singleton BackgroundService lifetime.
|
||||
/// </summary>
|
||||
public class FilamentUsageSyncJob : BackgroundService
|
||||
{
|
||||
private readonly IFilamentUsageSyncService _syncService;
|
||||
private readonly IServiceScopeFactory _scopeFactory;
|
||||
private readonly FilamentUsageSyncOptions _options;
|
||||
private readonly ILogger<FilamentUsageSyncJob> _logger;
|
||||
|
||||
/// <summary>
|
||||
/// Creates a new FilamentUsageSyncJob.
|
||||
/// </summary>
|
||||
/// <param name="syncService">The service that performs the actual sync logic.</param>
|
||||
/// <param name="scopeFactory">Factory for creating DI scopes to resolve scoped services.</param>
|
||||
/// <param name="options">Configuration options for polling interval and timeouts.</param>
|
||||
/// <param name="logger">Logger for diagnostic output.</param>
|
||||
public FilamentUsageSyncJob(
|
||||
IFilamentUsageSyncService syncService,
|
||||
IServiceScopeFactory scopeFactory,
|
||||
IOptions<FilamentUsageSyncOptions> options,
|
||||
ILogger<FilamentUsageSyncJob> logger)
|
||||
{
|
||||
_syncService = syncService;
|
||||
_scopeFactory = scopeFactory;
|
||||
_options = options.Value;
|
||||
_logger = logger;
|
||||
}
|
||||
@@ -57,8 +63,10 @@ public class FilamentUsageSyncJob : BackgroundService
|
||||
while (!stoppingToken.IsCancellationRequested)
|
||||
{
|
||||
try
|
||||
{
|
||||
var syncedCount = await _syncService.SyncAllAsync(stoppingToken);
|
||||
{
|
||||
using var scope = _scopeFactory.CreateScope();
|
||||
var syncService = scope.ServiceProvider.GetRequiredService<IFilamentUsageSyncService>();
|
||||
var syncedCount = await syncService.SyncAllAsync(stoppingToken);
|
||||
|
||||
_logger.LogInformation(
|
||||
"Filament usage sync completed — {SyncedCount} printer(s) synced. Next sync in {Interval}",
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
using Extrudex.Domain.Interfaces;
|
||||
using Extrudex.Infrastructure.Configuration;
|
||||
using Microsoft.Extensions.DependencyInjection;
|
||||
using Microsoft.Extensions.Hosting;
|
||||
using Microsoft.Extensions.Logging;
|
||||
using Microsoft.Extensions.Options;
|
||||
@@ -19,22 +20,22 @@ namespace Extrudex.API.Jobs;
|
||||
/// </summary>
|
||||
public class MoonrakerPrinterSyncJob : BackgroundService
|
||||
{
|
||||
private readonly IMoonrakerPrinterSyncService _syncService;
|
||||
private readonly IServiceScopeFactory _scopeFactory;
|
||||
private readonly MoonrakerPrinterSyncOptions _options;
|
||||
private readonly ILogger<MoonrakerPrinterSyncJob> _logger;
|
||||
|
||||
/// <summary>
|
||||
/// Creates a new MoonrakerPrinterSyncJob.
|
||||
/// </summary>
|
||||
/// <param name="syncService">The service that performs the actual sync logic.</param>
|
||||
/// <param name="scopeFactory">Factory for creating DI scopes to resolve scoped services.</param>
|
||||
/// <param name="options">Configuration options for polling interval and timeouts.</param>
|
||||
/// <param name="logger">Logger for diagnostic output.</param>
|
||||
public MoonrakerPrinterSyncJob(
|
||||
IMoonrakerPrinterSyncService syncService,
|
||||
IServiceScopeFactory scopeFactory,
|
||||
IOptions<MoonrakerPrinterSyncOptions> options,
|
||||
ILogger<MoonrakerPrinterSyncJob> logger)
|
||||
{
|
||||
_syncService = syncService;
|
||||
_scopeFactory = scopeFactory;
|
||||
_options = options.Value;
|
||||
_logger = logger;
|
||||
}
|
||||
@@ -59,7 +60,9 @@ public class MoonrakerPrinterSyncJob : BackgroundService
|
||||
{
|
||||
try
|
||||
{
|
||||
var syncedCount = await _syncService.SyncAllAsync(stoppingToken);
|
||||
using var scope = _scopeFactory.CreateScope();
|
||||
var syncService = scope.ServiceProvider.GetRequiredService<IMoonrakerPrinterSyncService>();
|
||||
var syncedCount = await syncService.SyncAllAsync(stoppingToken);
|
||||
|
||||
_logger.LogInformation(
|
||||
"Moonraker printer sync completed — {SyncedCount} printer(s) synced. Next sync in {Interval}",
|
||||
|
||||
@@ -1,50 +0,0 @@
|
||||
using Extrudex.Domain.Entities;
|
||||
|
||||
namespace Extrudex.Domain.Interfaces;
|
||||
|
||||
/// <summary>
|
||||
/// Service for persisting and querying filament usage records.
|
||||
/// Tracks consumption per print job and per spool for COGS and inventory tracking.
|
||||
/// </summary>
|
||||
public interface IFilamentUsageService
|
||||
{
|
||||
/// <summary>
|
||||
/// Records a new filament usage entry for a print job.
|
||||
/// </summary>
|
||||
/// <param name="printJobId">The print job that consumed the filament.</param>
|
||||
/// <param name="spoolId">The spool that provided the filament.</param>
|
||||
/// <param name="printerId">The printer that executed the print.</param>
|
||||
/// <param name="gramsUsed">Grams of filament consumed.</param>
|
||||
/// <param name="mmExtruded">Millimeters of filament extruded.</param>
|
||||
/// <param name="notes">Optional notes about this usage record.</param>
|
||||
/// <param name="cancellationToken">Cancellation token.</param>
|
||||
/// <returns>The created FilamentUsage entity.</returns>
|
||||
Task<FilamentUsage> RecordUsageAsync(
|
||||
Guid printJobId,
|
||||
Guid spoolId,
|
||||
Guid printerId,
|
||||
decimal gramsUsed,
|
||||
decimal mmExtruded,
|
||||
string? notes = null,
|
||||
CancellationToken cancellationToken = default);
|
||||
|
||||
/// <summary>
|
||||
/// Retrieves all filament usage records for a specific print job.
|
||||
/// </summary>
|
||||
/// <param name="printJobId">The print job ID.</param>
|
||||
/// <param name="cancellationToken">Cancellation token.</param>
|
||||
/// <returns>Collection of filament usage records for the print job.</returns>
|
||||
Task<IReadOnlyList<FilamentUsage>> GetByPrintJobAsync(
|
||||
Guid printJobId,
|
||||
CancellationToken cancellationToken = default);
|
||||
|
||||
/// <summary>
|
||||
/// Retrieves all filament usage records for a specific spool.
|
||||
/// </summary>
|
||||
/// <param name="spoolId">The spool ID.</param>
|
||||
/// <param name="cancellationToken">Cancellation token.</param>
|
||||
/// <returns>Collection of filament usage records for the spool.</returns>
|
||||
Task<IReadOnlyList<FilamentUsage>> GetBySpoolAsync(
|
||||
Guid spoolId,
|
||||
CancellationToken cancellationToken = default);
|
||||
}
|
||||
@@ -1,79 +0,0 @@
|
||||
using Extrudex.Domain.Entities;
|
||||
using Extrudex.Domain.Interfaces;
|
||||
using Extrudex.Infrastructure.Data;
|
||||
using Microsoft.EntityFrameworkCore;
|
||||
using Microsoft.Extensions.Logging;
|
||||
|
||||
namespace Extrudex.Infrastructure.Services;
|
||||
|
||||
/// <summary>
|
||||
/// EF Core–backed implementation of the filament usage service.
|
||||
/// Persists usage records to the database and provides query methods
|
||||
/// for retrieving usage by print job or spool.
|
||||
/// </summary>
|
||||
public class FilamentUsageService : IFilamentUsageService
|
||||
{
|
||||
private readonly ExtrudexDbContext _dbContext;
|
||||
private readonly ILogger<FilamentUsageService> _logger;
|
||||
|
||||
public FilamentUsageService(
|
||||
ExtrudexDbContext dbContext,
|
||||
ILogger<FilamentUsageService> logger)
|
||||
{
|
||||
_dbContext = dbContext;
|
||||
_logger = logger;
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public async Task<FilamentUsage> RecordUsageAsync(
|
||||
Guid printJobId,
|
||||
Guid spoolId,
|
||||
Guid printerId,
|
||||
decimal gramsUsed,
|
||||
decimal mmExtruded,
|
||||
string? notes = null,
|
||||
CancellationToken cancellationToken = default)
|
||||
{
|
||||
var usage = new FilamentUsage
|
||||
{
|
||||
PrintJobId = printJobId,
|
||||
SpoolId = spoolId,
|
||||
PrinterId = printerId,
|
||||
GramsUsed = gramsUsed,
|
||||
MmExtruded = mmExtruded,
|
||||
RecordedAt = DateTime.UtcNow,
|
||||
Notes = notes
|
||||
};
|
||||
|
||||
_dbContext.FilamentUsages.Add(usage);
|
||||
await _dbContext.SaveChangesAsync(cancellationToken);
|
||||
|
||||
_logger.LogInformation(
|
||||
"Recorded filament usage: {Grams}g / {Mm}mm for print job {JobId} on spool {SpoolId}",
|
||||
gramsUsed, mmExtruded, printJobId, spoolId);
|
||||
|
||||
return usage;
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public async Task<IReadOnlyList<FilamentUsage>> GetByPrintJobAsync(
|
||||
Guid printJobId,
|
||||
CancellationToken cancellationToken = default)
|
||||
{
|
||||
return await _dbContext.FilamentUsages
|
||||
.Where(u => u.PrintJobId == printJobId)
|
||||
.OrderByDescending(u => u.RecordedAt)
|
||||
.ToListAsync(cancellationToken);
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public async Task<IReadOnlyList<FilamentUsage>> GetBySpoolAsync(
|
||||
Guid spoolId,
|
||||
CancellationToken cancellationToken = default)
|
||||
{
|
||||
return await _dbContext.FilamentUsages
|
||||
.Where(u => u.SpoolId == spoolId)
|
||||
.OrderByDescending(u => u.RecordedAt)
|
||||
.ToListAsync(cancellationToken);
|
||||
}
|
||||
}
|
||||
@@ -1,21 +1,24 @@
|
||||
using Extrudex.Domain.DTOs.Moonraker;
|
||||
using Extrudex.Domain.Entities;
|
||||
using Extrudex.Domain.Enums;
|
||||
using Extrudex.Domain.Interfaces;
|
||||
using Extrudex.Infrastructure.Data;
|
||||
using Microsoft.EntityFrameworkCore;
|
||||
using Microsoft.Extensions.Logging;
|
||||
|
||||
namespace Extrudex.Infrastructure.Configuration;
|
||||
namespace Extrudex.Infrastructure.Services;
|
||||
|
||||
/// <summary>
|
||||
/// Service that syncs filament usage data from Moonraker printers into the
|
||||
/// Extrudex database. Queries all active Moonraker printers, fetches their
|
||||
/// current filament usage metrics, and updates spool remaining weights and
|
||||
/// print job records.
|
||||
/// current filament usage metrics, persists usage entries to the UsageLog table,
|
||||
/// creates FilamentUsage records for completed jobs, and updates spool remaining weights.
|
||||
/// </summary>
|
||||
public class FilamentUsageSyncService : IFilamentUsageSyncService
|
||||
{
|
||||
private readonly ExtrudexDbContext _dbContext;
|
||||
private readonly IMoonrakerClient _moonrakerClient;
|
||||
private readonly IUsageLogService _usageLogService;
|
||||
private readonly ILogger<FilamentUsageSyncService> _logger;
|
||||
|
||||
/// <summary>
|
||||
@@ -23,14 +26,17 @@ public class FilamentUsageSyncService : IFilamentUsageSyncService
|
||||
/// </summary>
|
||||
/// <param name="dbContext">The EF Core database context for persisting updates.</param>
|
||||
/// <param name="moonrakerClient">The Moonraker HTTP client for fetching printer data.</param>
|
||||
/// <param name="usageLogService">The usage log service for persisting usage entries.</param>
|
||||
/// <param name="logger">Logger for diagnostic output.</param>
|
||||
public FilamentUsageSyncService(
|
||||
ExtrudexDbContext dbContext,
|
||||
IMoonrakerClient moonrakerClient,
|
||||
IUsageLogService usageLogService,
|
||||
ILogger<FilamentUsageSyncService> logger)
|
||||
{
|
||||
_dbContext = dbContext;
|
||||
_moonrakerClient = moonrakerClient;
|
||||
_usageLogService = usageLogService;
|
||||
_logger = logger;
|
||||
}
|
||||
|
||||
@@ -43,7 +49,9 @@ public class FilamentUsageSyncService : IFilamentUsageSyncService
|
||||
.Where(p => p.IsActive && p.ConnectionType == ConnectionType.Moonraker)
|
||||
.Include(p => p.AmsUnits)
|
||||
.ThenInclude(u => u.Slots)
|
||||
.ThenInclude(s => s.Spool)
|
||||
.ThenInclude(s => s.Spool!)
|
||||
.ThenInclude(s => s.MaterialBase)
|
||||
.Include(p => p.PrintJobs)
|
||||
.ToListAsync(cancellationToken);
|
||||
|
||||
if (printers.Count == 0)
|
||||
@@ -60,33 +68,18 @@ public class FilamentUsageSyncService : IFilamentUsageSyncService
|
||||
{
|
||||
try
|
||||
{
|
||||
var usageData = await _moonrakerClient.GetFilamentUsageAsync(
|
||||
printer.HostnameOrIp,
|
||||
printer.Port,
|
||||
printer.ApiKey,
|
||||
cancellationToken);
|
||||
|
||||
if (usageData.Count == 0)
|
||||
{
|
||||
_logger.LogWarning(
|
||||
"No usage data returned from printer {PrinterName} ({Host}:{Port})",
|
||||
printer.Name, printer.HostnameOrIp, printer.Port);
|
||||
continue;
|
||||
}
|
||||
|
||||
// Update spool remaining weights from AMS data
|
||||
UpdateSpoolWeights(printer, usageData);
|
||||
|
||||
// Mark printer as seen and idle (reachable = idle, not printing)
|
||||
printer.LastSeenAt = DateTime.UtcNow;
|
||||
printer.Status = PrinterStatus.Idle;
|
||||
|
||||
await SyncPrinterAsync(printer, cancellationToken);
|
||||
syncedCount++;
|
||||
_logger.LogInformation(
|
||||
"Successfully synced filament usage from printer {PrinterName}",
|
||||
printer.Name);
|
||||
}
|
||||
catch (Exception ex)
|
||||
catch (HttpRequestException ex)
|
||||
{
|
||||
_logger.LogError(ex,
|
||||
"Connection error syncing filament usage from printer {PrinterName} ({Host}:{Port}) — printer may be offline",
|
||||
printer.Name, printer.HostnameOrIp, printer.Port);
|
||||
|
||||
printer.Status = PrinterStatus.Offline;
|
||||
}
|
||||
catch (Exception ex) when (ex is not OperationCanceledException)
|
||||
{
|
||||
_logger.LogError(ex,
|
||||
"Error syncing filament usage from printer {PrinterName} ({Host}:{Port})",
|
||||
@@ -103,12 +96,168 @@ public class FilamentUsageSyncService : IFilamentUsageSyncService
|
||||
return syncedCount;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Syncs a single Moonraker printer: fetches print stats and history,
|
||||
/// persists usage data to UsageLog and FilamentUsage tables, and
|
||||
/// updates spool remaining weights.
|
||||
/// </summary>
|
||||
private async Task SyncPrinterAsync(Printer printer, CancellationToken cancellationToken)
|
||||
{
|
||||
// Step 1: Fetch current print stats for real-time filament usage
|
||||
var printStats = await _moonrakerClient.GetPrintStatsAsync(
|
||||
printer.HostnameOrIp, printer.Port, printer.ApiKey, cancellationToken);
|
||||
|
||||
// Step 2: Fetch usage dictionary for backward-compatible metrics
|
||||
var usageData = await _moonrakerClient.GetFilamentUsageAsync(
|
||||
printer.HostnameOrIp, printer.Port, printer.ApiKey, cancellationToken);
|
||||
|
||||
// Step 3: Update printer status based on print stats
|
||||
if (printStats != null)
|
||||
{
|
||||
printer.Status = printStats.State.ToLowerInvariant() switch
|
||||
{
|
||||
"printing" => PrinterStatus.Printing,
|
||||
"paused" => PrinterStatus.Paused,
|
||||
"complete" => PrinterStatus.Idle,
|
||||
"standby" => PrinterStatus.Idle,
|
||||
"cancelled" => PrinterStatus.Idle,
|
||||
"error" => PrinterStatus.Error,
|
||||
_ => printer.Status
|
||||
};
|
||||
}
|
||||
|
||||
printer.LastSeenAt = DateTime.UtcNow;
|
||||
|
||||
// Step 4: Update spool remaining weights from AMS data
|
||||
UpdateSpoolWeights(printer, usageData);
|
||||
|
||||
// Step 5: If there's filament usage from print stats, persist it
|
||||
if (printStats != null && printStats.FilamentUsedMm > 0)
|
||||
{
|
||||
await PersistFilamentUsageAsync(printer, printStats, cancellationToken);
|
||||
}
|
||||
else if (usageData.TryGetValue("mm_extruded", out var mmExtruded) && mmExtruded > 0)
|
||||
{
|
||||
// Fall back to dictionary metrics if print stats aren't available
|
||||
_logger.LogInformation(
|
||||
"Printer {PrinterName} reports {MmExtruded}mm filament extruded in latest job (from usage dictionary)",
|
||||
printer.Name, mmExtruded);
|
||||
}
|
||||
|
||||
_logger.LogInformation(
|
||||
"Successfully synced filament usage from printer {PrinterName}",
|
||||
printer.Name);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Persists filament usage data from print stats to the database.
|
||||
/// Creates a FilamentUsage record and a UsageLog entry, and deducts
|
||||
/// consumed grams from the spool's remaining weight.
|
||||
/// </summary>
|
||||
private async Task PersistFilamentUsageAsync(
|
||||
Printer printer,
|
||||
MoonrakerPrintStats printStats,
|
||||
CancellationToken cancellationToken)
|
||||
{
|
||||
// Find the default spool for this printer
|
||||
var defaultSpool = FindDefaultSpool(printer);
|
||||
|
||||
if (defaultSpool == null)
|
||||
{
|
||||
_logger.LogWarning(
|
||||
"No default spool found for printer {PrinterName} — cannot persist filament usage of {MmExtruded}mm",
|
||||
printer.Name, printStats.FilamentUsedMm);
|
||||
return;
|
||||
}
|
||||
|
||||
// Calculate derived grams
|
||||
var gramsDerived = CalculateGrams(
|
||||
printStats.FilamentUsedMm,
|
||||
defaultSpool.FilamentDiameterMm,
|
||||
defaultSpool.MaterialBase.DensityGperCm3);
|
||||
|
||||
if (gramsDerived <= 0)
|
||||
{
|
||||
_logger.LogDebug(
|
||||
"No grams derived for printer {PrinterName} — skipping usage persistence",
|
||||
printer.Name);
|
||||
return;
|
||||
}
|
||||
|
||||
// Deduct from spool remaining weight (floor at 0)
|
||||
var previousWeight = defaultSpool.WeightRemainingGrams;
|
||||
defaultSpool.WeightRemainingGrams = Math.Max(0, defaultSpool.WeightRemainingGrams - gramsDerived);
|
||||
|
||||
_logger.LogInformation(
|
||||
"Deducted {Grams:F1}g from spool {SpoolSerial} (was {Previous:F1}g, now {Current:F1}g) for printer {PrinterName}",
|
||||
gramsDerived, defaultSpool.SpoolSerial, previousWeight, defaultSpool.WeightRemainingGrams, printer.Name);
|
||||
|
||||
// Check if we already have a recent FilamentUsage for this printer
|
||||
// to avoid double-counting on repeated poll cycles for the same job
|
||||
var recentUsageThreshold = DateTime.UtcNow.AddMinutes(-10);
|
||||
var existingRecentUsage = await _dbContext.FilamentUsages
|
||||
.Where(fu => fu.PrinterId == printer.Id && fu.RecordedAt >= recentUsageThreshold)
|
||||
.AnyAsync(cancellationToken);
|
||||
|
||||
if (existingRecentUsage)
|
||||
{
|
||||
_logger.LogDebug(
|
||||
"Recent FilamentUsage record exists for printer {PrinterName} — skipping to avoid double-counting",
|
||||
printer.Name);
|
||||
return;
|
||||
}
|
||||
|
||||
// Create a FilamentUsage entity for the consumption
|
||||
var filamentUsage = new FilamentUsage
|
||||
{
|
||||
SpoolId = defaultSpool.Id,
|
||||
PrinterId = printer.Id,
|
||||
GramsUsed = gramsDerived,
|
||||
MmExtruded = printStats.FilamentUsedMm,
|
||||
RecordedAt = DateTime.UtcNow,
|
||||
Notes = $"Auto-recorded from Moonraker print stats (state: {printStats.State})"
|
||||
};
|
||||
|
||||
// If there's a matching print job, link it
|
||||
var matchingJob = FindMatchingPrintJob(printer, printStats);
|
||||
if (matchingJob != null)
|
||||
{
|
||||
filamentUsage.PrintJobId = matchingJob.Id;
|
||||
filamentUsage.PrintJob = matchingJob;
|
||||
}
|
||||
|
||||
_dbContext.FilamentUsages.Add(filamentUsage);
|
||||
|
||||
// Also persist to UsageLog via the usage logging service
|
||||
try
|
||||
{
|
||||
await _usageLogService.RecordUsageAsync(
|
||||
spoolId: defaultSpool.Id,
|
||||
gramsUsed: gramsDerived,
|
||||
dataSource: DataSource.Moonraker,
|
||||
printerId: printer.Id,
|
||||
printJobId: matchingJob?.Id,
|
||||
mmExtruded: printStats.FilamentUsedMm,
|
||||
notes: $"Auto-recorded from Moonraker print stats (state: {printStats.State})");
|
||||
|
||||
_logger.LogInformation(
|
||||
"Persisted usage log: {Grams:F1}g / {Mm:F1}mm for spool {SpoolSerial} on printer {PrinterName}",
|
||||
gramsDerived, printStats.FilamentUsedMm, defaultSpool.SpoolSerial, printer.Name);
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
_logger.LogError(ex,
|
||||
"Failed to persist usage log for printer {PrinterName} — FilamentUsage entity was still created",
|
||||
printer.Name);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Updates spool remaining weights based on usage data received from Moonraker.
|
||||
/// For printers with AMS units, updates the remaining weight on each slot's spool.
|
||||
/// </summary>
|
||||
private void UpdateSpoolWeights(
|
||||
Domain.Entities.Printer printer,
|
||||
Printer printer,
|
||||
Dictionary<string, decimal> usageData)
|
||||
{
|
||||
// Update AMS slot remaining weights if available
|
||||
@@ -122,7 +271,7 @@ public class FilamentUsageSyncService : IFilamentUsageSyncService
|
||||
slot.Spool.WeightRemainingGrams = slot.RemainingWeightG.Value;
|
||||
|
||||
_logger.LogDebug(
|
||||
"Updated spool {SpoolSerial} remaining weight to {Weight}g",
|
||||
"Updated spool {SpoolSerial} remaining weight to {Weight}g from AMS data",
|
||||
slot.Spool.SpoolSerial, slot.RemainingWeightG.Value);
|
||||
}
|
||||
}
|
||||
@@ -136,4 +285,56 @@ public class FilamentUsageSyncService : IFilamentUsageSyncService
|
||||
printer.Name, mmExtruded);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Finds the default spool for a printer. Returns the first active, non-archived spool
|
||||
/// loaded in an AMS slot, or null if no spool is available.
|
||||
/// </summary>
|
||||
private static Spool? FindDefaultSpool(Printer printer)
|
||||
{
|
||||
foreach (var amsUnit in printer.AmsUnits)
|
||||
{
|
||||
foreach (var slot in amsUnit.Slots)
|
||||
{
|
||||
if (slot.Spool != null && slot.Spool.IsActive && !slot.Spool.IsArchived)
|
||||
{
|
||||
return slot.Spool;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Finds a PrintJob on this printer that matches the current print stats.
|
||||
/// Matches by filename and non-completed status to avoid double-linking.
|
||||
/// </summary>
|
||||
private PrintJob? FindMatchingPrintJob(Printer printer, MoonrakerPrintStats printStats)
|
||||
{
|
||||
if (string.IsNullOrEmpty(printStats.Filename))
|
||||
return null;
|
||||
|
||||
return printer.PrintJobs
|
||||
.FirstOrDefault(pj => pj.PrintName == printStats.Filename
|
||||
&& pj.Status != JobStatus.Completed
|
||||
&& pj.Status != JobStatus.Cancelled);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Calculates derived grams from millimeters extruded using the standard formula:
|
||||
/// grams = mm_extruded × cross_section_area × material_density
|
||||
/// where cross_section_area = π × (diameter / 2)²
|
||||
/// </summary>
|
||||
private static decimal CalculateGrams(decimal mmExtruded, decimal diameterMm, decimal densityGperCm3)
|
||||
{
|
||||
if (mmExtruded <= 0) return 0m;
|
||||
|
||||
var radiusCm = (double)diameterMm / 2.0 / 10.0; // mm to cm
|
||||
var crossSectionAreaCm2 = Math.PI * radiusCm * radiusCm;
|
||||
var mmToCm = (double)mmExtruded / 10.0;
|
||||
|
||||
var grams = mmToCm * crossSectionAreaCm2 * (double)densityGperCm3;
|
||||
return (decimal)grams;
|
||||
}
|
||||
}
|
||||
@@ -46,7 +46,7 @@ public class MoonrakerPrinterSyncService : IMoonrakerPrinterSyncService
|
||||
.Where(p => p.IsActive && p.ConnectionType == ConnectionType.Moonraker)
|
||||
.Include(p => p.AmsUnits)
|
||||
.ThenInclude(u => u.Slots)
|
||||
.ThenInclude(s => s.Spool)
|
||||
.ThenInclude(s => s.Spool!)
|
||||
.ThenInclude(s => s.MaterialBase)
|
||||
.Include(p => p.PrintJobs)
|
||||
.ToListAsync(cancellationToken);
|
||||
|
||||
@@ -1,390 +0,0 @@
|
||||
using Extrudex.Domain.DTOs.Moonraker;
|
||||
using Extrudex.Domain.Entities;
|
||||
using Extrudex.Domain.Enums;
|
||||
using Extrudex.Domain.Interfaces;
|
||||
using Extrudex.Infrastructure.Data;
|
||||
using Microsoft.EntityFrameworkCore;
|
||||
using Microsoft.Extensions.Logging;
|
||||
using Microsoft.Extensions.Options;
|
||||
|
||||
namespace Extrudex.Infrastructure.Services;
|
||||
|
||||
/// <summary>
|
||||
/// Configuration options for the Moonraker usage polling service.
|
||||
/// </summary>
|
||||
public class MoonrakerPollerOptions
|
||||
{
|
||||
/// <summary>
|
||||
/// How often to poll each Moonraker printer for filament usage data.
|
||||
/// Default: 30 seconds.
|
||||
/// </summary>
|
||||
public TimeSpan PollInterval { get; set; } = TimeSpan.FromSeconds(30);
|
||||
|
||||
/// <summary>
|
||||
/// Timeout for individual Moonraker HTTP requests.
|
||||
/// Default: 10 seconds.
|
||||
/// </summary>
|
||||
public TimeSpan RequestTimeout { get; set; } = TimeSpan.FromSeconds(10);
|
||||
|
||||
/// <summary>
|
||||
/// Whether the polling service is enabled. Default: true.
|
||||
/// Set to false to disable polling (e.g., in development or testing).
|
||||
/// </summary>
|
||||
public bool Enabled { get; set; } = true;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Background service that periodically polls Moonraker-connected printers
|
||||
/// for filament usage data. When a print job is detected as complete,
|
||||
/// the usage data is persisted to the FilamentUsage table via
|
||||
/// <see cref="IFilamentUsageService"/>.
|
||||
///
|
||||
/// <para>Polling logic:</para>
|
||||
/// <list type="number">
|
||||
/// <item>Query the database for all active printers with ConnectionType == Moonraker.</item>
|
||||
/// <item>For each printer, call <see cref="IMoonrakerClient.GetPrintStatsAsync"/> for live data
|
||||
/// and <see cref="IMoonrakerClient.GetPrintHistoryAsync"/> for completed job history.</item>
|
||||
/// <item>If usage data is available and the print state is "complete",
|
||||
/// create or update a FilamentUsage record.</item>
|
||||
/// <item>If the printer is unreachable or returns malformed data, log a warning
|
||||
/// and continue to the next printer (no crash).</item>
|
||||
/// </list>
|
||||
///
|
||||
/// <para>Error handling:</para>
|
||||
/// <list type="bullet">
|
||||
/// <item>API unreachable: logged as warning, poller continues for other printers.</item>
|
||||
/// <item>Malformed response: logged as warning, poller continues.</item>
|
||||
/// <item>Database errors: logged as error, poller continues.</item>
|
||||
/// </list>
|
||||
/// </summary>
|
||||
public class MoonrakerUsagePoller : BackgroundService
|
||||
{
|
||||
private readonly IServiceScopeFactory _scopeFactory;
|
||||
private readonly ILogger<MoonrakerUsagePoller> _logger;
|
||||
private readonly MoonrakerPollerOptions _options;
|
||||
|
||||
/// <summary>
|
||||
/// Tracks which Moonraker print jobs have already been recorded,
|
||||
/// keyed by "printerId:gcodeFileName" to avoid duplicate recording.
|
||||
/// </summary>
|
||||
private readonly HashSet<string> _recordedJobs = new();
|
||||
|
||||
public MoonrakerUsagePoller(
|
||||
IServiceScopeFactory scopeFactory,
|
||||
ILogger<MoonrakerUsagePoller> logger,
|
||||
IOptions<MoonrakerPollerOptions> options)
|
||||
{
|
||||
_scopeFactory = scopeFactory;
|
||||
_logger = logger;
|
||||
_options = options.Value;
|
||||
}
|
||||
|
||||
protected override async Task ExecuteAsync(CancellationToken stoppingToken)
|
||||
{
|
||||
if (!_options.Enabled)
|
||||
{
|
||||
_logger.LogInformation("Moonraker usage poller is disabled via configuration.");
|
||||
return;
|
||||
}
|
||||
|
||||
_logger.LogInformation(
|
||||
"Moonraker usage poller starting. Poll interval: {Interval}",
|
||||
_options.PollInterval);
|
||||
|
||||
while (!stoppingToken.IsCancellationRequested)
|
||||
{
|
||||
try
|
||||
{
|
||||
await PollAllPrintersAsync(stoppingToken);
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
_logger.LogError(ex,
|
||||
"Unexpected error in Moonraker usage poller cycle. Continuing.");
|
||||
}
|
||||
|
||||
await Task.Delay(_options.PollInterval, stoppingToken);
|
||||
}
|
||||
|
||||
_logger.LogInformation("Moonraker usage poller stopping.");
|
||||
}
|
||||
|
||||
private async Task PollAllPrintersAsync(CancellationToken cancellationToken)
|
||||
{
|
||||
using var scope = _scopeFactory.CreateScope();
|
||||
var dbContext = scope.ServiceProvider.GetRequiredService<ExtrudexDbContext>();
|
||||
var moonrakerClient = scope.ServiceProvider.GetRequiredService<IMoonrakerClient>();
|
||||
var usageService = scope.ServiceProvider.GetRequiredService<IFilamentUsageService>();
|
||||
|
||||
var printers = await dbContext.Printers
|
||||
.Where(p => p.IsActive && p.ConnectionType == ConnectionType.Moonraker)
|
||||
.ToListAsync(cancellationToken);
|
||||
|
||||
if (printers.Count == 0)
|
||||
{
|
||||
_logger.LogDebug("No active Moonraker printers found.");
|
||||
return;
|
||||
}
|
||||
|
||||
_logger.LogDebug("Polling {Count} Moonraker printer(s).", printers.Count);
|
||||
|
||||
foreach (var printer in printers)
|
||||
{
|
||||
await PollPrinterAsync(
|
||||
printer, moonrakerClient, usageService, dbContext, cancellationToken);
|
||||
}
|
||||
}
|
||||
|
||||
private async Task PollPrinterAsync(
|
||||
Printer printer,
|
||||
IMoonrakerClient moonrakerClient,
|
||||
IFilamentUsageService usageService,
|
||||
ExtrudexDbContext dbContext,
|
||||
CancellationToken cancellationToken)
|
||||
{
|
||||
_logger.LogDebug(
|
||||
"Polling Moonraker printer {PrinterName} ({Host}:{Port})",
|
||||
printer.Name, printer.HostnameOrIp, printer.Port);
|
||||
|
||||
try
|
||||
{
|
||||
var printStats = await moonrakerClient.GetPrintStatsAsync(
|
||||
printer.HostnameOrIp,
|
||||
printer.Port,
|
||||
printer.ApiKey,
|
||||
cancellationToken);
|
||||
|
||||
if (printStats is null)
|
||||
{
|
||||
_logger.LogDebug(
|
||||
"No print stats available from printer {PrinterName}.", printer.Name);
|
||||
return;
|
||||
}
|
||||
|
||||
printer.LastSeenAt = DateTime.UtcNow;
|
||||
await dbContext.SaveChangesAsync(cancellationToken);
|
||||
|
||||
_logger.LogDebug(
|
||||
"Printer {PrinterName}: state={State}, filament={Mm}mm, file={File}",
|
||||
printer.Name, printStats.State, printStats.FilamentUsedMm, printStats.Filename);
|
||||
|
||||
decimal mmExtruded = printStats.FilamentUsedMm;
|
||||
if (mmExtruded <= 0)
|
||||
{
|
||||
_logger.LogDebug(
|
||||
"Printer {PrinterName} has no filament usage to record.", printer.Name);
|
||||
return;
|
||||
}
|
||||
|
||||
if (!IsCompleteState(printStats.State))
|
||||
{
|
||||
_logger.LogDebug(
|
||||
"Printer {PrinterName} print state '{State}' is not complete; skipping.",
|
||||
printer.Name, printStats.State);
|
||||
return;
|
||||
}
|
||||
|
||||
string gcodeFileName = printStats.Filename ?? $"unknown-{Guid.NewGuid():N}";
|
||||
var deduplicationKey = $"{printer.Id}:{gcodeFileName}";
|
||||
if (_recordedJobs.Contains(deduplicationKey))
|
||||
{
|
||||
_logger.LogDebug(
|
||||
"Printer {PrinterName} job '{File}' already recorded; skipping.",
|
||||
printer.Name, gcodeFileName);
|
||||
return;
|
||||
}
|
||||
|
||||
DateTime? startedAt = null;
|
||||
DateTime? completedAt = null;
|
||||
try
|
||||
{
|
||||
var history = await moonrakerClient.GetPrintHistoryAsync(
|
||||
printer.HostnameOrIp, printer.Port, printer.ApiKey,
|
||||
limit: 1, cancellationToken);
|
||||
|
||||
if (history.Items.Count > 0)
|
||||
{
|
||||
var latestJob = history.Items[0];
|
||||
startedAt = latestJob.StartTime;
|
||||
completedAt = latestJob.EndTime;
|
||||
}
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
_logger.LogDebug(ex,
|
||||
"Could not fetch history for printer {PrinterName}; proceeding with stats only.",
|
||||
printer.Name);
|
||||
}
|
||||
|
||||
var printJob = await FindOrCreatePrintJobAsync(
|
||||
dbContext, printer, mmExtruded, gcodeFileName,
|
||||
startedAt, completedAt, cancellationToken);
|
||||
|
||||
if (printJob is null)
|
||||
{
|
||||
_logger.LogWarning(
|
||||
"Could not find or create print job for printer {PrinterName}. No active spool found.",
|
||||
printer.Name);
|
||||
return;
|
||||
}
|
||||
|
||||
var spool = await dbContext.Spools.FindAsync(
|
||||
new object[] { printJob.SpoolId }, cancellationToken);
|
||||
|
||||
var gramsUsed = CalculateGramsUsed(mmExtruded, spool);
|
||||
|
||||
await usageService.RecordUsageAsync(
|
||||
printJobId: printJob.Id,
|
||||
spoolId: printJob.SpoolId,
|
||||
printerId: printer.Id,
|
||||
gramsUsed: gramsUsed,
|
||||
mmExtruded: mmExtruded,
|
||||
notes: $"Moonraker auto-recorded: {gcodeFileName}",
|
||||
cancellationToken: cancellationToken);
|
||||
|
||||
_recordedJobs.Add(deduplicationKey);
|
||||
|
||||
_logger.LogInformation(
|
||||
"Recorded Moonraker usage for printer {PrinterName}: {Mm}mm / {Grams}g, job '{File}'",
|
||||
printer.Name, mmExtruded, gramsUsed, gcodeFileName);
|
||||
}
|
||||
catch (HttpRequestException ex)
|
||||
{
|
||||
_logger.LogWarning(ex,
|
||||
"Moonraker API unreachable for printer {PrinterName} ({Host}:{Port}). Will retry next cycle.",
|
||||
printer.Name, printer.HostnameOrIp, printer.Port);
|
||||
}
|
||||
catch (TaskCanceledException) when (cancellationToken.IsCancellationRequested)
|
||||
{
|
||||
throw;
|
||||
}
|
||||
catch (TaskCanceledException ex)
|
||||
{
|
||||
_logger.LogWarning(ex,
|
||||
"Moonraker request timed out for printer {PrinterName} ({Host}:{Port}).",
|
||||
printer.Name, printer.HostnameOrIp, printer.Port);
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
_logger.LogError(ex,
|
||||
"Unexpected error polling Moonraker printer {PrinterName}. Continuing to next printer.",
|
||||
printer.Name);
|
||||
}
|
||||
}
|
||||
|
||||
private static bool IsCompleteState(string state) =>
|
||||
state.Equals("complete", StringComparison.OrdinalIgnoreCase) ||
|
||||
state.Equals("completed", StringComparison.OrdinalIgnoreCase);
|
||||
|
||||
private async Task<PrintJob?> FindOrCreatePrintJobAsync(
|
||||
ExtrudexDbContext dbContext,
|
||||
Printer printer,
|
||||
decimal mmExtruded,
|
||||
string gcodeFileName,
|
||||
DateTime? startedAt,
|
||||
DateTime? completedAt,
|
||||
CancellationToken cancellationToken)
|
||||
{
|
||||
if (!string.IsNullOrEmpty(gcodeFileName))
|
||||
{
|
||||
var existingJob = await dbContext.PrintJobs
|
||||
.Where(j => j.PrinterId == printer.Id &&
|
||||
j.GcodeFilePath == gcodeFileName &&
|
||||
j.DataSource == DataSource.Moonraker &&
|
||||
j.Status != JobStatus.Cancelled)
|
||||
.OrderByDescending(j => j.CreatedAt)
|
||||
.FirstOrDefaultAsync(cancellationToken);
|
||||
|
||||
if (existingJob is not null)
|
||||
{
|
||||
existingJob.MmExtruded = mmExtruded;
|
||||
existingJob.GramsDerived = CalculateGramsUsed(
|
||||
mmExtruded,
|
||||
await dbContext.Spools.FindAsync(
|
||||
new object[] { existingJob.SpoolId }, cancellationToken));
|
||||
existingJob.Status = JobStatus.Completed;
|
||||
existingJob.CompletedAt = completedAt ?? DateTime.UtcNow;
|
||||
existingJob.StartedAt ??= startedAt;
|
||||
await dbContext.SaveChangesAsync(cancellationToken);
|
||||
return existingJob;
|
||||
}
|
||||
}
|
||||
|
||||
var spool = await FindActiveSpoolForPrinterAsync(dbContext, printer, cancellationToken);
|
||||
if (spool is null) return null;
|
||||
|
||||
var gramsDerived = CalculateGramsUsed(mmExtruded, spool);
|
||||
|
||||
var newJob = new PrintJob
|
||||
{
|
||||
PrinterId = printer.Id,
|
||||
SpoolId = spool.Id,
|
||||
PrintName = gcodeFileName ?? "Moonraker Print",
|
||||
GcodeFilePath = gcodeFileName,
|
||||
MmExtruded = mmExtruded,
|
||||
GramsDerived = gramsDerived,
|
||||
FilamentDiameterAtPrintMm = spool.FilamentDiameterMm,
|
||||
MaterialDensityAtPrint = GetMaterialDensity(spool),
|
||||
DataSource = DataSource.Moonraker,
|
||||
Status = JobStatus.Completed,
|
||||
StartedAt = startedAt ?? DateTime.UtcNow,
|
||||
CompletedAt = completedAt ?? DateTime.UtcNow,
|
||||
Notes = "Auto-created by Moonraker usage poller"
|
||||
};
|
||||
|
||||
dbContext.PrintJobs.Add(newJob);
|
||||
await dbContext.SaveChangesAsync(cancellationToken);
|
||||
|
||||
return newJob;
|
||||
}
|
||||
|
||||
private static async Task<Spool?> FindActiveSpoolForPrinterAsync(
|
||||
ExtrudexDbContext dbContext,
|
||||
Printer printer,
|
||||
CancellationToken cancellationToken)
|
||||
{
|
||||
var amsSpool = await dbContext.AmsSlots
|
||||
.Include(s => s.Spool)
|
||||
.ThenInclude(s => s!.MaterialBase)
|
||||
.Include(s => s.AmsUnit)
|
||||
.Where(s => s.AmsUnit.PrinterId == printer.Id && s.Spool != null && s.Spool.IsActive)
|
||||
.Select(s => s.Spool)
|
||||
.FirstOrDefaultAsync(cancellationToken);
|
||||
|
||||
if (amsSpool is not null) return amsSpool;
|
||||
|
||||
return await dbContext.Spools
|
||||
.Include(s => s.MaterialBase)
|
||||
.Where(s => s.IsActive)
|
||||
.OrderByDescending(s => s.WeightRemainingGrams)
|
||||
.FirstOrDefaultAsync(cancellationToken);
|
||||
}
|
||||
|
||||
private static decimal CalculateGramsUsed(decimal mmExtruded, Spool? spool)
|
||||
{
|
||||
if (spool is null) return 0m;
|
||||
var diameterMm = spool.FilamentDiameterMm;
|
||||
var densityGcm3 = GetMaterialDensity(spool);
|
||||
var radiusMm = diameterMm / 2m;
|
||||
var crossSectionArea = Math.PI * (double)radiusMm * (double)radiusMm;
|
||||
var volumeMm3 = (double)mmExtruded * crossSectionArea;
|
||||
var volumeCm3 = volumeMm3 / 1000.0;
|
||||
var grams = volumeCm3 * (double)densityGcm3;
|
||||
return Math.Round((decimal)grams, 2);
|
||||
}
|
||||
|
||||
private static decimal GetMaterialDensity(Spool? spool)
|
||||
{
|
||||
return spool?.MaterialBase?.Name?.ToUpperInvariant() switch
|
||||
{
|
||||
"PLA" => 1.24m,
|
||||
"PETG" => 1.27m,
|
||||
"ABS" => 1.04m,
|
||||
"ASA" => 1.07m,
|
||||
"TPU" => 1.21m,
|
||||
"NYLON" or "PA" => 1.13m,
|
||||
"PC" => 1.20m,
|
||||
_ => 1.24m
|
||||
};
|
||||
}
|
||||
}
|
||||
@@ -61,14 +61,6 @@ builder.Services.AddSingleton<ILowStockDetector, LowStockDetector>();
|
||||
// ── Usage Logging ───────────────────────────────────────────
|
||||
builder.Services.AddScoped<IUsageLogService, UsageLogService>();
|
||||
|
||||
// ── Filament Usage Service ──────────────────────────────────
|
||||
builder.Services.AddScoped<IFilamentUsageService, FilamentUsageService>();
|
||||
|
||||
// ── Moonraker Usage Poller (Background Service) ─────────────
|
||||
builder.Services.Configure<MoonrakerPollerOptions>(
|
||||
builder.Configuration.GetSection("MoonrakerPoller"));
|
||||
builder.Services.AddHostedService<MoonrakerUsagePoller>();
|
||||
|
||||
// ── FluentValidation ──────────────────────────────────────
|
||||
// Registers all validators from the API assembly into DI.
|
||||
builder.Services.AddValidatorsFromAssembly(Assembly.GetExecutingAssembly());
|
||||
|
||||
@@ -23,11 +23,5 @@
|
||||
},
|
||||
"FilamentAlerts": {
|
||||
"LowStockThresholdPercent": 20
|
||||
},
|
||||
"MoonrakerPoller": {
|
||||
"Enabled": true,
|
||||
"PollInterval": "00:00:30",
|
||||
"RequestTimeout": "00:00:10"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,517 +0,0 @@
|
||||
# Extrudex Mobile-First Design System
|
||||
|
||||
> **Project:** CUB-71 — Mobile-First Touch-Optimized UI Design
|
||||
> **Parent:** CUB-67 — Extrudex Mobile-First PWA Implementation
|
||||
> **Date:** 2026-05-01
|
||||
> **Author:** Sketch
|
||||
> **Status:** In Progress
|
||||
|
||||
---
|
||||
|
||||
## 1. Design Philosophy
|
||||
|
||||
### Mobile-First, Touch-Always
|
||||
- **Minimum touch target:** 44×44px (Apple HIG) / 48×48dp (Material Design)
|
||||
- **Thumb-friendly zones:** Primary actions in bottom 25% of screen
|
||||
- **Gesture support:** Swipe, pull-to-refresh, pinch-to-zoom on relevant screens
|
||||
- **One-handed use:** All critical actions reachable within thumb zone
|
||||
|
||||
### Workshop-Ready
|
||||
- **High contrast:** WCAG AA minimum (4.5:1) — workshop lighting varies
|
||||
- **Large text:** 16sp minimum body, 20sp+ for primary info
|
||||
- **Glanceable:** Key info visible at arm's length (3ft)
|
||||
- **Glove-compatible:** Larger tap targets for operators wearing work gloves
|
||||
|
||||
### Speed Over Complexity
|
||||
- **Sub-second load:** Cached assets, skeleton screens
|
||||
- **Minimal taps:** Every flow optimized for fewest interactions
|
||||
- **Smart defaults:** Pre-filled forms based on context
|
||||
|
||||
---
|
||||
|
||||
## 2. Color System
|
||||
|
||||
### Primary Palette (Dark Theme — Default)
|
||||
|
||||
| Token | Hex | Usage |
|
||||
|-------|-----|-------|
|
||||
| `surface` | `#1C1B1F` | Screen background |
|
||||
| `onSurface` | `#E6E1E5` | Primary text |
|
||||
| `surfaceContainer` | `#211F26` | Cards, app bar |
|
||||
| `surfaceContainerHigh` | `#2B2930` | Elevated cards |
|
||||
| `primary` | `#A8CEDA` | FAB, active states, links |
|
||||
| `onPrimary` | `#00303E` | Text on primary |
|
||||
| `primaryContainer` | `#004D63` | Chip fills, tonal buttons |
|
||||
| `onPrimaryContainer` | `#A8CEDA` | Text on primary container |
|
||||
| `secondary` | `#B1CCC7` | Secondary actions |
|
||||
| `error` | `#F2B8B5` | Critical stock, errors |
|
||||
| `errorContainer` | `#8C1D18` | Error backgrounds |
|
||||
| `warning` | `#FFD580` | Low stock warning |
|
||||
| `warningContainer` | `#5D4200` | Warning backgrounds |
|
||||
| `success` | `#8BD0A0` | Available, success states |
|
||||
| `successContainer` | `#00522E` | Success backgrounds |
|
||||
| `outline` | `#938F99` | Borders, dividers |
|
||||
| `outlineVariant` | `#49454F` | Subtle borders |
|
||||
|
||||
### Light Theme (Optional)
|
||||
|
||||
| Token | Hex | Usage |
|
||||
|-------|-----|-------|
|
||||
| `surface` | `#F8FAFC` | Screen background |
|
||||
| `surfaceContainer` | `#FFFFFF` | Cards |
|
||||
| `primary` | `#2563EB` | Primary actions |
|
||||
| `onSurface` | `#0F172A` | Primary text |
|
||||
|
||||
---
|
||||
|
||||
## 3. Typography Scale
|
||||
|
||||
### Mobile Type Scale
|
||||
|
||||
| Role | Token | Size | Weight | Line Height | Letter Spacing |
|
||||
|------|-------|------|--------|-------------|----------------|
|
||||
| Display Large | `displayLarge` | 57sp | 400 | 64sp | -0.25px |
|
||||
| Display Medium | `displayMedium` | 45sp | 400 | 52sp | 0 |
|
||||
| Headline Large | `headlineLarge` | 32sp | 400 | 40sp | 0 |
|
||||
| Headline Medium | `headlineMedium` | 28sp | 400 | 36sp | 0 |
|
||||
| Headline Small | `headlineSmall` | 24sp | 400 | 32sp | 0 |
|
||||
| Title Large | `titleLarge` | 22sp | 400 | 28sp | 0 |
|
||||
| Title Medium | `titleMedium` | 16sp | 500 | 24sp | 0.15px |
|
||||
| Title Small | `titleSmall` | 14sp | 500 | 20sp | 0.1px |
|
||||
| Body Large | `bodyLarge` | 16sp | 400 | 24sp | 0.5px |
|
||||
| Body Medium | `bodyMedium` | 14sp | 400 | 20sp | 0.25px |
|
||||
| Label Large | `labelLarge` | 14sp | 500 | 20sp | 0.1px |
|
||||
| Label Medium | `labelMedium` | 12sp | 500 | 16sp | 0.5px |
|
||||
| Label Small | `labelSmall` | 11sp | 500 | 16sp | 0.5px |
|
||||
|
||||
### Font Stack
|
||||
```css
|
||||
--font-sans: 'Inter', 'Roboto', system-ui, -apple-system, sans-serif;
|
||||
--font-mono: 'JetBrains Mono', 'Roboto Mono', monospace;
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 4. Spacing System
|
||||
|
||||
### 8dp Grid Base
|
||||
|
||||
| Token | Value | Usage |
|
||||
|-------|-------|-------|
|
||||
| `space-1` | 4dp | Tight padding, icon gaps |
|
||||
| `space-2` | 8dp | Default gap, small padding |
|
||||
| `space-3` | 12dp | Card padding (compact) |
|
||||
| `space-4` | 16dp | Standard padding, section gaps |
|
||||
| `space-5` | 20dp | Large padding |
|
||||
| `space-6` | 24dp | Section margins, hero padding |
|
||||
| `space-8` | 32dp | Large section gaps |
|
||||
| `space-10` | 40dp | Major section spacing |
|
||||
| `space-12` | 48dp | Touch target minimum |
|
||||
| `space-16` | 64dp | App bar height |
|
||||
|
||||
### Border Radius
|
||||
|
||||
| Token | Value | Usage |
|
||||
|-------|-------|-------|
|
||||
| `radius-sm` | 4dp | Small buttons, chips |
|
||||
| `radius-md` | 8dp | Cards, inputs |
|
||||
| `radius-lg` | 12dp | Modals, bottom sheets |
|
||||
| `radius-xl` | 16dp | Large cards, dialogs |
|
||||
| `radius-full` | 9999px | Pills, circular elements |
|
||||
|
||||
---
|
||||
|
||||
## 5. Component Specifications
|
||||
|
||||
### 5.1 Bottom Navigation Bar
|
||||
|
||||
**Height:** 80dp
|
||||
**Background:** `surfaceContainer` with 1dp top outline
|
||||
**Layout:** 4-5 icon+label items, evenly distributed
|
||||
**Active state:** Icon filled + `primary` color, label `primary`
|
||||
**Inactive state:** Icon outlined + `onSurfaceVariant` color
|
||||
**Touch target:** Full 80dp height, icon+label centered
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────┐
|
||||
│ 📦 🖨️ 📋 ⚙️ │
|
||||
│Inventory Printers Jobs Settings │
|
||||
└─────────────────────────────────────┘
|
||||
```
|
||||
|
||||
**Destinations:**
|
||||
- Inventory (spools list) — default active
|
||||
- Printers (printer fleet status)
|
||||
- Jobs (print job history)
|
||||
- Settings (app configuration)
|
||||
|
||||
---
|
||||
|
||||
### 5.2 QR Scanner Interface
|
||||
|
||||
**Layout:** Full-bleed camera viewport with overlay
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────┐
|
||||
│ ✕ Scan Spool [⚡] │ ← App Bar (56dp)
|
||||
├─────────────────────────────────────┤
|
||||
│ │
|
||||
│ ┌─────────────────────────────┐ │
|
||||
│ │ │ │
|
||||
│ │ ┌───────────────────┐ │ │
|
||||
│ │ │ ╔═══════════════╗ │ │ │
|
||||
│ │ │ ║ ▄▄▄▄▄▄▄▄▄▄▄ ║ │ │ │
|
||||
│ │ │ ║ █ VIEWPORT █ ║ │ │ │
|
||||
│ │ │ ║ █ FRAME █ ║ │ │ │
|
||||
│ │ │ ║ ▀▀▀▀▀▀▀▀▀▀▀ ║ │ │ │
|
||||
│ │ │ ║ (scan line) ║ │ │ │
|
||||
│ │ └───────────────────┘ │ │
|
||||
│ │ │ │
|
||||
│ │ LIVE CAMERA FEED │ │
|
||||
│ │ │ │
|
||||
│ └─────────────────────────────┘ │
|
||||
│ │
|
||||
│ [Last scan: 8901234567890] │
|
||||
│ │
|
||||
│ Can't scan? Enter manually │
|
||||
│ │
|
||||
└─────────────────────────────────────┘
|
||||
```
|
||||
|
||||
**Elements:**
|
||||
- **Camera viewport:** Full width, 60% screen height, `surfaceContainerHighest` background before camera starts
|
||||
- **Scanning frame:** 200dp × 120dp centered, corner brackets (3dp stroke, `primary`)
|
||||
- **Scan line:** Horizontal 2dp line, sweeps top→bottom (2s cycle), `primary` at 40% opacity
|
||||
- **Scan result chip:** Appears below viewport, monospace text, auto-advances in 1.5s
|
||||
- **Manual entry:** Text button fallback
|
||||
|
||||
**States:**
|
||||
| State | Visual |
|
||||
|-------|--------|
|
||||
| Initializing | Shimmer loading + "Starting camera…" |
|
||||
| Ready | Live feed + animated scan line |
|
||||
| Scanning | Frame flashes `success` green |
|
||||
| No match | Frame flashes `warning` yellow |
|
||||
| Camera denied | Error card + "Enter manually" button |
|
||||
|
||||
---
|
||||
|
||||
### 5.3 Spool Detail View (Mobile)
|
||||
|
||||
**Layout:** Scrollable vertical stack
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────┐
|
||||
│ ← PLA Basic — Matte Black [✏] │ ← App Bar
|
||||
├─────────────────────────────────────┤
|
||||
│ │
|
||||
│ ┌──────┐ │
|
||||
│ │SWATCH│ PLA Basic — Matte │
|
||||
│ │ 80dp │ Black [Avail] │
|
||||
│ └──────┘ Bambu Lab │
|
||||
│ │
|
||||
│ ◉ 842g / 1000g (67%) │ ← Circular progress
|
||||
│ │
|
||||
├─────────────────────────────────────┤
|
||||
│ Total Weight │ Remaining │
|
||||
│ 1,000g │ 842g (67%) │
|
||||
├─────────────────────────────────────┤
|
||||
│ Diameter │ Density │
|
||||
│ 1.75mm │ 1.24 g/cm³ │
|
||||
├─────────────────────────────────────┤
|
||||
│ Date Added │ Last Used │
|
||||
│ Mar 12, 2026 │ Apr 18, 2026 │
|
||||
├─────────────────────────────────────┤
|
||||
│ 📍 AMS Unit 2, Slot A3 [Move] │
|
||||
├─────────────────────────────────────┤
|
||||
│ ┌──────────┐ │
|
||||
│ │ QR CODE │ │
|
||||
│ │ 160dp │ EXT-2026-PLA-0042 │
|
||||
│ └──────────┘ [Reprint] │
|
||||
├─────────────────────────────────────┤
|
||||
│ Recent Usage │
|
||||
│ Print #1847 — Benchy -32g │
|
||||
│ Print #1842 — Housing -18g │
|
||||
│ [View Full History →] │
|
||||
├─────────────────────────────────────┤
|
||||
│ │
|
||||
│ [Depleted] [Move] [Print] │ ← Sticky action row
|
||||
│ │
|
||||
├─────────────────────────────────────┤
|
||||
│ 📦 🖨️ 📋 ⚙️ │ ← Bottom nav
|
||||
└─────────────────────────────────────┘
|
||||
```
|
||||
|
||||
**Hero Section:**
|
||||
- Color swatch: 80dp circle, `outlineVariant` border
|
||||
- Material name: `headlineMedium` (28sp)
|
||||
- Brand: `bodyLarge` (16sp), `onSurfaceVariant`
|
||||
- Status badge: Tonal chip
|
||||
- Circular progress: 96dp diameter, dynamic color based on percentage
|
||||
|
||||
**Metrics Grid:**
|
||||
- 2-column grid on mobile, 3-column on kiosk
|
||||
- Label: `labelMedium` (12sp)
|
||||
- Value: `titleMedium` (16sp)
|
||||
|
||||
**Action Row (Sticky):**
|
||||
- Height: 64dp minimum
|
||||
- Buttons: 48dp height minimum
|
||||
- Deplete: Outlined, `error` color
|
||||
- Move: Tonal, `secondary` color
|
||||
- Print: Filled, `primary` color
|
||||
|
||||
---
|
||||
|
||||
### 5.4 Print-Log Form (Quick Entry)
|
||||
|
||||
**Layout:** Bottom sheet or full-screen
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────┐
|
||||
│ ✕ Log Print Usage │
|
||||
├─────────────────────────────────────┤
|
||||
│ │
|
||||
│ Spool: PLA Basic — Matte Black │
|
||||
│ Remaining: 842g │
|
||||
│ │
|
||||
│ Weight Used │
|
||||
│ ┌─────────────────────────────┐ │
|
||||
│ │ [−] 32 [+] grams │ │ ← Stepper
|
||||
│ └─────────────────────────────┘ │
|
||||
│ │
|
||||
│ Quick: [10] [25] [50] [100] │
|
||||
│ │
|
||||
│ Print Job (optional) │
|
||||
│ ┌─────────────────────────────┐ │
|
||||
│ │ Select or enter job name... │ │
|
||||
│ └─────────────────────────────┘ │
|
||||
│ │
|
||||
│ Notes (optional) │
|
||||
│ ┌─────────────────────────────┐ │
|
||||
│ │ ... │ │
|
||||
│ └─────────────────────────────┘ │
|
||||
│ │
|
||||
│ ┌─────────────────────────────┐ │
|
||||
│ │ ✓ Log Print (842→810g) │ │
|
||||
│ └─────────────────────────────┘ │
|
||||
│ │
|
||||
└─────────────────────────────────────┘
|
||||
```
|
||||
|
||||
**Design Principles:**
|
||||
- **Number pad first:** Show numeric keyboard by default
|
||||
- **Quick-select chips:** Common values (10g, 25g, 50g, 100g)
|
||||
- **Stepper control:** ± buttons flanking input
|
||||
- **Live preview:** Show remaining weight after deduction
|
||||
- **Single-tap complete:** Primary action always visible
|
||||
|
||||
---
|
||||
|
||||
### 5.5 Status Badges
|
||||
|
||||
| Status | Background | Text | Icon |
|
||||
|--------|-----------|------|------|
|
||||
| Available | `successContainer` | `success` | check_circle |
|
||||
| In Use | `primaryContainer` | `primary` | print |
|
||||
| Low Stock | `warningContainer` | `warning` | warning |
|
||||
| Critical | `errorContainer` | `error` | error |
|
||||
| Depleted | `errorContainer` | `error` | remove_circle |
|
||||
|
||||
---
|
||||
|
||||
### 5.6 Touch Targets & Accessibility
|
||||
|
||||
**Minimum Sizes:**
|
||||
- Interactive elements: 48×48dp
|
||||
- List items: 56dp height minimum
|
||||
- Buttons: 48dp height, 88dp minimum width
|
||||
- Chips: 32dp height, 48dp minimum width
|
||||
- Input fields: 56dp height
|
||||
|
||||
**Focus States:**
|
||||
- 2dp outline, `primary` color, 2dp offset
|
||||
- Visible on keyboard navigation
|
||||
|
||||
**Motion:**
|
||||
- Respect `prefers-reduced-motion`
|
||||
- Disable animations when set
|
||||
- Use opacity fades instead of transforms
|
||||
|
||||
---
|
||||
|
||||
## 6. Responsive Breakpoints
|
||||
|
||||
| Breakpoint | Width | Target |
|
||||
|-----------|-------|--------|
|
||||
| Compact | 0-599dp | Mobile phones |
|
||||
| Medium | 600-839dp | Large phones, small tablets |
|
||||
| Expanded | 840-1199dp | Tablets, small desktops |
|
||||
| Large | 1200dp+ | Desktops, kiosks |
|
||||
|
||||
### Layout Adaptations
|
||||
|
||||
| Property | Compact (Mobile) | Large (Kiosk) |
|
||||
|----------|-----------------|---------------|
|
||||
| Navigation | Bottom bar (80dp) | Rail (80dp, left) |
|
||||
| Content padding | 16dp | 24dp |
|
||||
| Grid columns | 1-2 | 2-3 |
|
||||
| Card padding | 16dp | 20dp |
|
||||
| Typography scale | Standard | +10% for distance viewing |
|
||||
| Touch targets | 48dp | 56dp (glove-friendly) |
|
||||
|
||||
---
|
||||
|
||||
## 7. Animation & Motion
|
||||
|
||||
### Principles
|
||||
- **Purposeful:** Every animation guides attention or provides feedback
|
||||
- **Fast:** 200-300ms standard duration
|
||||
- **Easing:** `ease-out` for entrances, `ease-in-out` for transitions
|
||||
|
||||
### Patterns
|
||||
|
||||
| Animation | Duration | Easing | Use Case |
|
||||
|-----------|----------|--------|----------|
|
||||
| Slide in | 300ms | ease-out | Screen transitions |
|
||||
| Fade | 200ms | ease-in-out | Modal/dialog |
|
||||
| Scale | 200ms | ease-out | Button presses |
|
||||
| Shimmer | 1.5s | linear | Loading skeletons |
|
||||
| Pulse | 2s | ease-in-out | Scan line, critical alerts |
|
||||
| Progress | 600ms | ease-out | Circular progress fill |
|
||||
|
||||
### Interaction Feedback
|
||||
- **Button press:** Scale to 0.96, 100ms
|
||||
- **Chip select:** Background color transition, 150ms
|
||||
- **List item tap:** Ripple effect, `primary` at 12% opacity
|
||||
- **Success:** Green flash + haptic (mobile)
|
||||
- **Error:** Red flash + shake animation
|
||||
|
||||
---
|
||||
|
||||
## 8. Assets & Icons
|
||||
|
||||
### Icon Set
|
||||
- **Library:** Material Symbols (rounded)
|
||||
- **Size:** 24dp default, 20dp in dense areas
|
||||
- **Weight:** 400 (regular), filled for active states
|
||||
|
||||
### Required Icons
|
||||
| Icon | Name | Usage |
|
||||
|------|------|-------|
|
||||
| 📦 | inventory_2 | Inventory nav |
|
||||
| 🖨️ | print | Printers nav |
|
||||
| 📋 | assignment | Jobs nav |
|
||||
| ⚙️ | settings | Settings nav |
|
||||
| ✕ | close | Close/dismiss |
|
||||
| ← | arrow_back | Navigate back |
|
||||
| ✏ | edit | Edit action |
|
||||
| 🔍 | search | Search toggle |
|
||||
| + | add | Add/create |
|
||||
| 🗑 | delete | Delete action |
|
||||
| 📷 | photo_camera | Scan action |
|
||||
| ⚠ | warning | Warning states |
|
||||
| ✓ | check_circle | Success states |
|
||||
| 📍 | location_on | Location |
|
||||
| 📶 | signal_cellular_alt | SignalR status |
|
||||
|
||||
---
|
||||
|
||||
## 9. Developer Handoff Checklist
|
||||
|
||||
- [x] Color tokens defined (dark theme)
|
||||
- [x] Typography scale specified
|
||||
- [x] Spacing system documented
|
||||
- [x] Component specifications written
|
||||
- [x] Touch targets validated (≥48dp)
|
||||
- [x] Responsive breakpoints defined
|
||||
- [x] Animation patterns documented
|
||||
- [x] Icon set specified
|
||||
- [ ] Mockup images generated (blocked — image generation unavailable)
|
||||
- [ ] Figma/Sketch file created (optional)
|
||||
- [ ] Design tokens exported to CSS/SCSS
|
||||
|
||||
---
|
||||
|
||||
## 10. Implementation Notes for Rex
|
||||
|
||||
### Priority Order
|
||||
1. Bottom navigation component
|
||||
2. QR scanner interface (camera + overlay)
|
||||
3. Spool detail view (scrollable)
|
||||
4. Print-log form (bottom sheet)
|
||||
5. Status badges and indicators
|
||||
|
||||
### Angular Material Components Needed
|
||||
```typescript
|
||||
import { MatBottomSheetModule } from '@angular/material/bottom-sheet';
|
||||
import { MatButtonModule } from '@angular/material/button';
|
||||
import { MatCardModule } from '@angular/material/card';
|
||||
import { MatChipsModule } from '@angular/material/chips';
|
||||
import { MatDialogModule } from '@angular/material/dialog';
|
||||
import { MatFormFieldModule } from '@angular/material/form-field';
|
||||
import { MatIconModule } from '@angular/material/icon';
|
||||
import { MatInputModule } from '@angular/material/input';
|
||||
import { MatProgressBarModule } from '@angular/material/progress-bar';
|
||||
import { MatProgressSpinnerModule } from '@angular/material/progress-spinner';
|
||||
import { MatSelectModule } from '@angular/material/select';
|
||||
import { MatSnackBarModule } from '@angular/material/snack-bar';
|
||||
import { MatToolbarModule } from '@angular/material/toolbar';
|
||||
```
|
||||
|
||||
### QR Scanning Libraries
|
||||
- **Mobile:** `html5-qrcode` or `@zxing/browser`
|
||||
- **Camera access:** `navigator.mediaDevices.getUserMedia({ facingMode: 'environment' })`
|
||||
|
||||
### Key Files to Create
|
||||
```
|
||||
frontend/src/app/
|
||||
├── components/
|
||||
│ ├── bottom-nav/
|
||||
│ │ ├── bottom-nav.component.ts
|
||||
│ │ ├── bottom-nav.component.html
|
||||
│ │ └── bottom-nav.component.scss
|
||||
│ ├── qr-scanner/
|
||||
│ │ ├── qr-scanner.component.ts
|
||||
│ │ ├── qr-scanner.component.html
|
||||
│ │ └── qr-scanner.component.scss
|
||||
│ ├── spool-detail/
|
||||
│ │ ├── spool-detail.component.ts
|
||||
│ │ ├── spool-detail.component.html
|
||||
│ │ └── spool-detail.component.scss
|
||||
│ └── print-log-form/
|
||||
│ ├── print-log-form.component.ts
|
||||
│ ├── print-log-form.component.html
|
||||
│ └── print-log-form.component.scss
|
||||
├── design-system/
|
||||
│ ├── _colors.scss
|
||||
│ ├── _typography.scss
|
||||
│ ├── _spacing.scss
|
||||
│ └── _mixins.scss
|
||||
└── models/
|
||||
└── mobile-ui.model.ts
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 11. File Locations
|
||||
|
||||
| File | Path | Purpose |
|
||||
|------|------|---------|
|
||||
| Design System | `design/mobile-design-system.md` | This document |
|
||||
| Inventory Spec | `design/01-filament-inventory-list.md` | Existing — inventory screen |
|
||||
| Spool Detail Spec | `design/02-spool-detail-view.md` | Existing — detail screen |
|
||||
| Smart Intake Spec | `design/03-smart-intake-workflow.md` | Existing — intake flow |
|
||||
| Identify Spec | `design/smart-intake-identify-spec.md` | Existing — identify state |
|
||||
| Mockup Images | `design/mockup-*.png/jpg` | Visual references |
|
||||
|
||||
---
|
||||
|
||||
**Next Steps:**
|
||||
1. Review design system with stakeholders
|
||||
2. Generate mockup images (when image generation is available)
|
||||
3. Export design tokens to SCSS
|
||||
4. Hand off to Rex for implementation
|
||||
5. Create interactive prototype (optional)
|
||||
|
||||
**Status:** Design system document complete. Ready for implementation handoff.
|
||||
Reference in New Issue
Block a user