Skip to content

Latest commit

 

History

History
78 lines (56 loc) · 5 KB

README.md

File metadata and controls

78 lines (56 loc) · 5 KB

SliderDoc

JKSlider

Documentation and manuals for an open DIY motorized camera slider ecosystem: UIC (SliderCtrl) + MC (SliderMC) + BDC (SliderMC_BDC) + optional DMC (DF_DMC_2_MC) + shared UART contract.

Whether you operate on set, install a panel, build the rail, or extend the firmware — this repo is the single source for architecture, protocol, user manuals, and build guides. Mechanics and enclosure are yours; the docs cover control feel, motion firmware, and wiring so your build can behave like a commercial motorized slider on the things that matter for shooting — or as a construction kit for custom motorized rigs.

Linked code repositories

Repo Role
SliderCtrl UI controller — MicroPython panel firmware (JKSlider, B4Slider, libraries)
SliderMC Motion controller — C++ / FreeRTOS STEP/DIR (1–4 motors; typical linear + pan, time-synced)
SliderMC_BDC Motion controller — C++ / FreeRTOS brushed DC motors with AB encoders (up to 2 motors, 4 RC servos)
DF_DMC_2_MC Dragonframe DMC v2 USB bridge (RP2040-Zero) to SliderMC UART

Features (system summary)

One consolidated view of the whole stack — details live in each repo README and in architecture/marketing.md.

  • Motorized camera slider control — laptop-free set operation; analogue speed and accel; STOP / EMO / limits
  • JKSlider full panel + B4Slider AXIS-select remote — and room for more UIC faces on the same protocol
  • Construction kit — JKSlider / B4Slider panel apps, MC_Client / UIC_Base, SliderMC motion; build sliders, mini-dollies, rotating heads, turntables, slider + pan, or other STEP/DIR rigs
  • Optional extra motors — typical linear travel + pan (or tilt/turn), time-synced dual moves (not CNC); SliderMC CS motors 1..4 (default 1); MC_Client packed moveTo / home. Shipping JKSlider stays 1-motor; B4Slider selects packed axes 1–5. dual-movement.md · UIC API
  • Production moves — marks A/B/C, pair loops, DELAY, timelapse dividers, pause/resume, live retarget, camera trigger
  • Dedicated motion MCU — PIO step timing isolated from MicroPython UIC; crossed UART contract at 115200 baud
  • Open firmware, open docs — MIT licensed; Thonny / REPL and USB CLI; edit pins, fork panels, script moves
  • DIY mechanics — rail, motor, driver, and housing up to the builder; upcycle linear units and off-the-shelf STEP/DIR drivers

How this compares to commercial motorized sliders: architecture/compare.md.


Start here (by role)

I am… Start here
Operator jkslider/user-manual.md or b4slider/user-manual.md
Installer jkslider/technical/ + build/checklists/
Builder (mechanics) build/hardware-manual.md
UIC developer uic/api/overview.md
MC developer mc/README.md
BDC motor firmware mc-bdc/README.md
DMC / Dragonframe dmc/README.md
Protocol author contract/protocol.md

Documentation tree

Section Contents
architecture/ System split, command chains, compare, marketing
contract/ UART protocol, link/handshake, MC command cheat sheet
uic/ API, libraries, JKSlider / B4Slider / template projects
mc/ Build, config, pins, motion firmware (STEP/DIR)
mc-bdc/ Brushed-DC firmware: pins, drivers, tuning
dmc/ Dragonframe DMC bridge (DF_DMC_2_MC)
components/ Tested hardware module catalog
build/ Hardware manual + installer checklists
reference/ Glossary
assets/ Images, SVG, pinout text, OLED mockups
tools/ Render/sim scripts (maintainers)

Maintaining docs

See CONTRIBUTING.md. Regenerate cheat sheets and pinouts with scripts in tools/.


License

Copyright (c) 2026 Jochen Krapf <jk@nerd2nerd.org>

Licensed under the MIT License.

Company names and product names mentioned in this project are trademarks or registered trademarks of their respective owners. Use here is for identification only.