Skip to content

Rename VFM to SFM across firmware, docs, and URLs - #26

Merged
jeminkachhadiya merged 1 commit into
mainfrom
rename/vfm-to-sfm
Aug 27, 2026
Merged

Rename VFM to SFM across firmware, docs, and URLs#26
jeminkachhadiya merged 1 commit into
mainfrom
rename/vfm-to-sfm

Conversation

@jeminkachhadiya

Copy link
Copy Markdown
Contributor

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.

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>
@jeminkachhadiya
jeminkachhadiya merged commit c9ca551 into main Aug 27, 2026
17 of 18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant