Phase 7: Advanced Features (Network Config, SD Card, Firmware)

[tylerkron]

Phase 7: Advanced Features

This issue tracks Phase 7 from the migration plan: migrating advanced device features from daqifi-desktop to daqifi-core.

Success Criteria

7.1 Network Configuration

• WiFi SSID and password configuration
• WiFi security mode selection (Open, WEP, WPA, WPA2)
• LAN settings (IP address, subnet, gateway)
• Network configuration persistence on device
• Network status queries
• Apply configuration and reboot sequence

7.2 SD Card Operations

• Enable/disable SD card logging mode
• File listing (text-based response handling)
• File retrieval from device
• SD card format commands
• Storage capacity queries
• File management (delete, rename)
• Text message consumer for SD card responses (non-protobuf)

7.3 Device Configuration Persistence

• Device settings save/load
• Configuration validation
• Default configuration restoration
• Configuration versioning
• Cross-device configuration compatibility

7.4 Firmware Update Support

• Firmware version comparison and validation
• Bootloader mode detection and entry
• Firmware upload protocol (HID-based)
• Upload progress tracking
• Firmware verification
• Device reboot after update
• Rollback on failure

7.5 Logging and Diagnostics

• Device-level logging interface
• Diagnostic message capture
• Performance metrics (connection time, message latency)
• Error tracking and reporting
• Debug mode with verbose logging

Implementation Guidance

Network Configuration Example

public class NetworkConfiguration
{
    public string? WifiSsid { get; set; }
    public string? WifiPassword { get; set; }
    public WifiSecurityMode SecurityMode { get; set; }
    public IPAddress? StaticIP { get; set; }
    public IPAddress? SubnetMask { get; set; }
    public IPAddress? Gateway { get; set; }
}

public interface INetworkConfigurable
{
    Task<NetworkConfiguration> GetNetworkConfigAsync();
    Task SetNetworkConfigAsync(NetworkConfiguration config);
    Task ApplyNetworkConfigAsync(); // Saves and reboots device
}

SD Card Operations Example

public interface ISdCardSupport
{
    bool SdCardLoggingEnabled { get; set; }
    
    Task<IEnumerable<SdCardFileInfo>> ListFilesAsync();
    Task<byte[]> RetrieveFileAsync(string filename);
    Task DeleteFileAsync(string filename);
    Task FormatSdCardAsync();
    Task<SdCardStatus> GetSdCardStatusAsync();
}

// Usage
var files = await device.ListFilesAsync();
foreach (var file in files)
{
    Console.WriteLine($"{file.Name} - {file.Size} bytes - {file.Timestamp}");
}

var data = await device.RetrieveFileAsync("log_2024_10_16.csv");

Firmware Update Example

public interface IFirmwareUpdateSupport
{
    string CurrentFirmwareVersion { get; }
    
    Task<bool> EnterBootloaderModeAsync();
    Task<FirmwareUpdateResult> UpdateFirmwareAsync(
        byte[] firmwareData, 
        IProgress<int>? progress = null);
    Task<bool> VerifyFirmwareAsync();
}

// Usage
var progress = new Progress<int>(p => Console.WriteLine($"Upload progress: {p}%"));
var result = await device.UpdateFirmwareAsync(firmwareBytes, progress);

if (result.Success)
{
    Console.WriteLine($"Firmware updated to {result.NewVersion}");
}

Desktop Migration Impact

Once complete, desktop can migrate:

• Network configuration UI → use core's INetworkConfigurable
• SD card operations → use core's ISdCardSupport
• Firmware update logic → use core's IFirmwareUpdateSupport
• Device logging → use core's diagnostic interfaces
• Configuration management → use core's persistence

Testing Requirements

• Unit tests for network configuration commands
• SD card operation tests (with mock responses)
• Text message consumer tests (SD card file listings)
• Firmware version comparison tests
• Configuration validation tests
• Mock bootloader communication tests
• Integration tests for complete workflows
• Error handling and rollback tests

Target Version

Core 0.9.0

Dependencies

• Depends on: Phase 6 (Protocol Implementation)
• Blocks: Phase 8 (Desktop Integration & Adapters)

Related Documentation

Desktop implementation references:

• /Device/AbstractStreamingDevice.cs - Network config, SD card operations
• /Bootloader/ - Firmware update implementation
• /IO/Messages/Consumers/TextMessageConsumer.cs - SD card text responses
• HID library usage for bootloader communication

Notes

• SD card operations use text-based responses (not protobuf), requiring TextMessageConsumer
• Firmware updates require HID library for bootloader communication
• Network configuration requires device reboot to apply changes
• Some operations may be device-type specific (not all DAQiFi devices support all features)

[tylerkron]

Phase 7.4 Firmware Update — Implementation Tickets Created

The firmware update migration has been broken into detailed, actionable tickets:

Core Library (daqifi/daqifi-core)

1. feat: Add PIC32 bootloader protocol layer (message producer/consumer, CRC16, HEX parsing) #105 — PIC32 bootloader protocol layer (message producer/consumer, CRC16, HEX parsing)
2. feat: Add firmware download service (GitHub releases API integration) #106 — Firmware download service (GitHub releases API integration)
3. feat: Add HID transport abstraction for bootloader communication #107 — HID transport abstraction for bootloader communication
4. feat: Add firmware update orchestration service (state machine, progress, timeout/retry) #108 — Firmware update orchestration service (state machine, progress, timeout/retry)

Example App (daqifi/daqifi-core-example-app)

5. feat: Add firmware update CLI commands (check, flash, wifi-update) daqifi-core-example-app#7 — Firmware update CLI commands (check, flash, wifi-update)
6. feat: Add hardware-in-the-loop firmware update validation script daqifi-core-example-app#8 — Hardware-in-the-loop firmware update validation script

Desktop Integration (daqifi/daqifi-desktop)

7. feat: migrate desktop firmware flows to Daqifi.Core v0.18.0 and remove Desktop.Bootloader daqifi-desktop#373 — Integrate core firmware services and retire Desktop.Bootloader project

Execution Order

#105 (protocol) ──┐
#106 (download) ──┼──→ #108 (orchestration) ──→ example-app#7 (CLI) ──→ example-app#8 (validation)
#107 (HID)     ──┘                                                  ──→ desktop#373 (integration)

#105, #106, and #107 can be worked in parallel. #108 depends on all three. Example app and desktop integration can proceed after #108, with the example app being the first consumer (for testing) before desktop integration.

This resolves the following open desktop bugs:

• fix: Bootloader HID Connection Issue daqifi-desktop#364 (HID connection)
• Add timeout to firmware flash. daqifi-desktop#131 (timeout)
• fix: WiFi module firmware update fails through desktop app but succeeds manually daqifi-desktop#187 (WiFi update)
• feat: check WiFi module firmware version before updating daqifi-desktop#185 (WiFi version check)
• Firmware update seems to throw exception daqifi-desktop#94 (IOException)