Skip to content

Latest commit

 

History

5 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SliderDoc

JKSlider

Documentation and manuals for an open DIY motorized camera slider ecosystem: UIC (SliderCtrl) + MC (SliderMC) + 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 (optional 2nd axis: typical linear + pan, time-synced)

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 minimal 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 2-axis — typical linear travel + pan (or tilt/turn), time-synced dual moves (not CNC); SliderMC axis2_use; MC_Client dual moveTo / home. Shipping panels stay 1-axis. 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 1 Mbaud
  • 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
Protocol author contract/protocol.md

Documentation tree

Section Contents
architecture/ System split, philosophy, compare, marketing
contract/ UART protocol, link/handshake, MC command cheat sheet
uic/ API, libraries, JKSlider / B4Slider / template projects
mc/ Build, config, pins, motion firmware
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.

About

Documentation and Manuals to all Slider Projects

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages