Adding files
This commit is contained in:
parent
d659f1c9cc
commit
23c919f62b
2
LICENSE
2
LICENSE
@ -1,6 +1,6 @@
|
|||||||
MIT License
|
MIT License
|
||||||
|
|
||||||
Copyright (c) 2025 FABLAB Bahrain
|
Copyright (c) 2024 FABLAB BH
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
35
README.md
35
README.md
@ -1,20 +1,29 @@
|
|||||||
# Relay8I2C Library
|
# I2CStepper
|
||||||
**By Fatima @ FABLAB Bahrain**
|
|
||||||
|
|
||||||

|
Control a stepper motor via I2C using a master-slave microcontroller setup.
|
||||||
|
|
||||||
Control Stepper via I2C with dynamic address configuration. Designed for ESP8266 and Arduino platforms.
|
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
- I2C communication protocol
|
|
||||||
- Dynamic slave address configuration
|
- Control stepper motors (e.g., TMC2209 + NEMA 17) over I2C
|
||||||
- Master controller with serial interface
|
- Change slave I2C address at runtime (persistent in EEPROM)
|
||||||
- Active LOW relay support
|
- Scan for available I2C devices
|
||||||
- EEPROM storage for persistent addressing
|
- Simple API for master and slave
|
||||||
|
- Example code included
|
||||||
|
|
||||||
|
## Hardware Requirements
|
||||||
|
|
||||||
|
- Two Arduino-compatible microcontrollers (e.g., Uno, ESP32, etc.)
|
||||||
|
- TMC2209 stepper driver or similar (STEP/DIR interface)
|
||||||
|
- NEMA 17 or compatible stepper motor
|
||||||
|
- I2C wiring between master and slave
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
1. Download the library ZIP
|
|
||||||
2. Arduino IDE: Sketch > Include Library > Add .ZIP Library
|
1. Download or clone this repository.
|
||||||
3. Select the downloaded ZIP file
|
2. Copy the folder to your Arduino `libraries` directory.
|
||||||
|
3. Open Arduino IDE and include `I2CStepper.h` in your project.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
|
### Master Example
|
||||||
|
|
||||||
|
BIN
fablab_stepper_motor.png
Normal file
BIN
fablab_stepper_motor.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 22 KiB |
16
keywords.txt
16
keywords.txt
@ -1,16 +0,0 @@
|
|||||||
#######################################
|
|
||||||
# Syntax coloring for I2CStepper Library
|
|
||||||
#######################################
|
|
||||||
|
|
||||||
# Classes
|
|
||||||
RelayI2CMaster KEYWORD1
|
|
||||||
I2CMasterUtils KEYWORD1
|
|
||||||
|
|
||||||
# Methods
|
|
||||||
begin KEYWORD2
|
|
||||||
|
|
||||||
scanI2C KEYWORD2
|
|
||||||
changeSlaveAddress KEYWORD2
|
|
||||||
|
|
||||||
# Constants
|
|
||||||
CMD_CHANGE_ADDR LITERAL1
|
|
@ -1,9 +1,10 @@
|
|||||||
name=FABLAB Stepper
|
name=I2CStepper
|
||||||
version=1.0.0
|
version=1.0.0
|
||||||
author=Fatima Idrees <fatimaxidrees@gmail.com>
|
author=Fatima Idrees <fatimaxidrees@gmail.com>
|
||||||
maintainer=Fatima Idrees <fatimaxidrees@gmail.com>
|
maintainer=Fatima Idrees <fatimaxidrees@gmail.com>
|
||||||
sentence=Control DC motors via I2C with scanning and configuration utilities.
|
sentence=Control a stepper motor via I2C using a master-slave microcontroller setup.
|
||||||
paragraph=Provides easy control of stepper motor modules via I2C communication with dynamic address configuration. Includes master/slave implementation for ESP32C3/Arduino platforms.
|
paragraph=I2CStepper allows you to control stepper motors (e.g., with TMC2209 drivers) over I2C, with address change and device scanning support. Designed for Arduino-compatible boards.
|
||||||
category=Device Control
|
category=Device Control
|
||||||
url=https://github.com/fablabbh/I2CMasterUtils
|
url=https://github.com/yourusername/I2CStepper
|
||||||
architectures=*
|
architectures=*
|
||||||
|
includes=I2CStepper.h
|
||||||
|
Loading…
x
Reference in New Issue
Block a user