Rename VFM to SFM across firmware, docs, and URLs - #26
Merged
Conversation
The project is the Spatial Foraging Platform; VFM was a legacy name. The Python side already used SFM (sfm-analysis, sfm_analysis, sfm_logs, SFM_LOG_DIR) — this brings the firmware and all prose in line. firmware/src/VFM.h -> firmware/src/SFM.h firmware/src/VFM.cpp -> firmware/src/SFM.cpp firmware/src/hardware/VFMPins.h -> firmware/src/hardware/SFMPins.h namespace vfm -> namespace sfm class VFM -> class SFM gVfm -> gSfm library.properties: name=VFM -> name=SFM BREAKING (Arduino library consumers): the library is now SFM. Delete any existing Arduino/libraries/VFM install and re-add firmware/ as SFM, and change #include <VFM.h> to #include <SFM.h> in your sketches. No wire formats or persisted data change: CAN frame IDs, the session CSV header, sfm_logs, and SFM_LOG_DIR contained no VFM. Existing session logs remain readable and the base-station/node protocol is unaffected. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The project is the Spatial Foraging Platform; VFM was a legacy name. The Python side already used SFM (sfm-analysis, sfm_analysis, sfm_logs, SFM_LOG_DIR) — this brings the firmware and all prose in line.
firmware/src/VFM.h -> firmware/src/SFM.h
firmware/src/VFM.cpp -> firmware/src/SFM.cpp
firmware/src/hardware/VFMPins.h -> firmware/src/hardware/SFMPins.h
namespace vfm -> namespace sfm
class VFM -> class SFM
gVfm -> gSfm
library.properties: name=VFM -> name=SFM
BREAKING (Arduino library consumers): the library is now SFM. Delete any existing Arduino/libraries/VFM install and re-add firmware/ as SFM, and change #include <VFM.h> to #include <SFM.h> in your sketches.
No wire formats or persisted data change: CAN frame IDs, the session CSV header, sfm_logs, and SFM_LOG_DIR contained no VFM. Existing session logs remain readable and the base-station/node protocol is unaffected.