Open-Acidification / Open-Acidification/TankControllerPico

SD Class Implementation

Open
#15 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
2
Forks
1
Avg merge
2h 22m
Merged PRs (30d)
2

Description

The SD class currently provides a partial interface for SD card operations. This issue tracks the work needed to fully implement and validate the SD storage functionality used across the device.

Goals

  • Expand the SD class to include complete, reliable SD card interaction features.
  • Review all methods defined in SD_TC (C++ implementation) and determine which should be included or updated.
  • Confirm compatibility with the target hardware environment and the SdFat library.

Reference: SD_TC Public Operations (from header file)

writeToDataLog()
appendToLog()
countFiles()
exists()
format()
getRemoteLogContents()
listRootToBuffer()
mkdir()
open()
printRootDirectory()
remove()
todaysDataFileName()
writeToRemoteLog()

Internal/Private Helper Methods

- appendStringToPath()
- iterateOnFiles()
- updateRemoteFileSize()
- incrementFileCount()
- listFile()

Additional Items for Review & Refinement

  • File-stack depth management (MAX_DEPTH)
  • Buffer management for file listing and log retrieval
  • Use of PROGMEM for remoteFileName
  • Error-state tracking via hasHadError
  • Proper singleton lifecycle management (instance() / deleteInstance())

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing the partial SD class with the SD_TC C++ implementation and its listed public and private operations. Review the SdFat usage, MAX_DEPTH, buffers, PROGMEM handling, error tracking, and singleton lifecycle against the target Raspberry Pi Pico environment. Done means the required operations are implemented or updated and the SD functionality is validated for hardware compatibility.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, raspberry-pi
Domain
embedded-iot
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.