Skip to content

Commit

Permalink
More docs migration
Browse files Browse the repository at this point in the history
  • Loading branch information
scottbez1 committed Dec 23, 2024
1 parent 9ae6a3a commit 72367a3
Show file tree
Hide file tree
Showing 4 changed files with 67 additions and 17 deletions.
32 changes: 16 additions & 16 deletions docs/ElectronicsGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@

# Intro

If you’re just getting started and want to learn more about the Chainlink Driver, jump to the [bottom of this document](https://paper.dropbox.com/doc/Chainlink-Driver-v1.1-User-Guide-BWhbqC5xa02TlskitjhIE95eAg-U0DAXrSxEoOhgSoRU39hq#:uid=233215592336409945310151&h2=What-is-the-Chainlink-Driver?) which includes some more background and general info.
If you’re just getting started and want to learn more about the Chainlink Driver, jump to the [bottom of this document](#what-is-the-chainlink-driver) which includes some more background and general info.

Please let me know if you have any questions or suggestions on how to improve these instructions - feel free to open a pull request or joing the [community Discord server](https://discord.gg/wgehm3PcrC)

Building a split-flap display? I would love to hear from you and see photos/videos of your project in progress or completed! This project has been a hobby of mine for a few years and the coolest part by far is hearing from other people making their own and seeing them in action. Feel free to shoot me an email at [email protected] 🙂 or, [join the Discord server](https://discord.gg/wgehm3PcrC), to share and discuss with the wider split-flap community!


# 1. Gather the parts
- Chainlink Driver PCB assembly (see [appendix](https://paper.dropbox.com/doc/Chainlink-Driver-v1.1-User-Guide--BWhbqC5xa02TlskitjhIE95eAg-U0DAXrSxEoOhgSoRU39hq#:uid=792547574481491886826014&h2=Where-to-buy-a-Chainlink-Drive) for ordering info)
- Chainlink Driver PCB assembly (see [appendix](#appendix) for ordering info)
- Connectors (all included with the Chainlink Driver boards I sell on Etsy)
- 6x JST XH 5-pin
- 6x 3-pin male headers
Expand All @@ -22,13 +22,13 @@ Building a split-flap display? I would love to hear from you and see photos/vide
- e.g. 22AWG solid hookup wire
- 12v power/ground wires
- 20AWG up to 14AWG depending on number of modules
- 12V Power supply (see [appendix](https://paper.dropbox.com/doc/Chainlink-Driver-v1.1-User-Guide--BWhbqC5xa02TlskitjhIE95eAg-U0DAXrSxEoOhgSoRU39hq#:uid=087574108452977023222089&h2=Power-supply-tips) for more info)
- 12V Power supply (see [appendix](#appendix) for more info)
- ESP32
![Chainlink Buddy [T-Display]](https://paper-attachments.dropbox.com/s_BBABC117AF455DD9F0525297940CD25AF9A358008ED7FF73463824486BCF5E62_1637360060741_DSC_5014_s.jpg)

- The [TTGO T-Display](https://amzn.to/3kHwhMm) [affiliate links help support this project at no cost to you, or use a [non-affiliate link](https://www.amazon.com/LILYGO-T-Display-Arduino-Development-CH9102F/dp/B099MPFJ9M) if you’d prefer] is the recommended ESP32 board, which includes a 240x135 LCD that the splitflap firmware supports out of the box. (Also available on [aliexpress](https://www.aliexpress.com/item/33048962331.html), which may be cheaper)
- An optional [Chainlink Buddy [T-Display]](https://www.etsy.com/listing/1109357786/splitflap-chainlink-buddy-t-display) is also highly recommended for most users, which makes it easy and clean to connect a T-Display to the Chainlink Driver.
- If you want to use an ESP32 module other than a T-Display, a [Chainlink Buddy [Breadboard]](https://www.etsy.com/listing/1123863267/splitflap-chainlink-buddy-breadboard) may be helpful in lieu of the T-Display Buddy. See the [appendix](https://paper.dropbox.com/doc/Chainlink-Driver-v1.1-User-Guide-BWhbqC5xa02TlskitjhIE95eAg-U0DAXrSxEoOhgSoRU39hq#:uid=376453206579860306500313&h2=Using-a-different-ESP32-module) for more info on using other ESP32 modules.
- An optional [Chainlink Buddy [T-Display]](https://bezeklabs.etsy.com/listing/1109357786/splitflap-chainlink-buddy-t-display) is also highly recommended for most users, which makes it easy and clean to connect a T-Display to the Chainlink Driver.
- If you want to use an ESP32 module other than a T-Display, a [Chainlink Buddy [Breadboard]](https://bezeklabs.etsy.com/listing/1123863267/splitflap-chainlink-buddy-breadboard) may be helpful in lieu of the T-Display Buddy. See the [appendix](#appendix) for more info on using other ESP32 modules.



Expand All @@ -53,7 +53,7 @@ Building a split-flap display? I would love to hear from you and see photos/vide

On the T-Display itself, you will solder the 2 rows of male headers (included in the box) to the T-Display, and then the whole module will plug into the matching female headers you soldered on the Buddy board.

You may notice a few empty spaces in the lower left of the T-Display Buddy PCB labeled C1 and C2 along with 3 through-holes; don’t worry, those are optional components and not needed for a basic setup. See [Standalone T-Display operation](https://paper.dropbox.com/doc/Chainlink-Driver-v1.1-Electronics-User-Guide--BlREVjC8f3CL~b2gMbh4IclCAg-U0DAXrSxEoOhgSoRU39hq#:uid=387792691852404644801520&h2=8.-(Optional)-Standalone-T-Dis) for more info.
You may notice a few empty spaces in the lower left of the T-Display Buddy PCB labeled C1 and C2 along with 3 through-holes; don’t worry, those are optional components and not needed for a basic setup. See [Standalone T-Display operation](#8-optional-standalone-t-display-operation) for more info.


![](https://paper-attachments.dropbox.com/s_BBABC117AF455DD9F0525297940CD25AF9A358008ED7FF73463824486BCF5E62_1647556549613_PXL_20220317_223022886.jpg)
Expand Down Expand Up @@ -92,7 +92,7 @@ We’ll start by connecting and testing just the Chainlink Driver, without conne
- Connect the ribbon cable from the Chainlink Buddy’s **Output** to the Chainlink Driver’s **Input**
- Connect a wire from the Chainlink Driver’s “Logic 3.3-5V” screw terminal to a 3.3v supply on your breadboard
- Connect a wire from the Chainlink Driver’s “GND” screw terminal to your breadboard’s ground rail
- Connect the 5 pins to your ESP32. See the [appendix](https://paper.dropbox.com/doc/Chainlink-Driver-v1.1-Electronics-User-Guide--BWhbqC5xa02TlskitjhIE95eAg-U0DAXrSxEoOhgSoRU39hq#:uid=376453206579860306500313&h2=Using-a-different-ESP32-module) for more info. Default pin assignments are:
- Connect the 5 pins to your ESP32. See the [appendix](#appendix) for more info. Default pin assignments are:
- Clock: 33
- Motor Data: 32
- Sensor Data: 39
Expand Down Expand Up @@ -134,7 +134,7 @@ You’ll need to configure NUM_MODULES in platformio.ini to match the number of
-DNUM_MODULES=6


- (If you’re *no*t **using a T-Display, see the [appendix](https://paper.dropbox.com/doc/Chainlink-Driver-v1.1-Electronics-User-Guide--BWhbqC5xa02TlskitjhIE95eAg-U0DAXrSxEoOhgSoRU39hq#:uid=376453206579860306500313&h2=Using-a-different-ESP32-module) for a few more changes you’ll need to make at this point)
- (If you’re *no*t **using a T-Display, see the [appendix](#appendix) for a few more changes you’ll need to make at this point)
- Mac Users: you will likely need to install updated drivers for the CH9102 USB-serial adapter used on newer versions of the ESP32 T-Display: https://learn.adafruit.com/how-to-install-drivers-for-wch-usb-to-serial-chips-ch9102f-ch9102/mac-driver-installation


Expand Down Expand Up @@ -174,16 +174,17 @@ The ESP32 and 3.3v electronics on the Chainlink Drivers are typically powered by
**T-Display**

- You can plug a DC 12v barrel jack into the T-Display Buddy when using 1 or 2 Chainlink Drivers
- ⚠️ For more than 2 Chainlink Drivers, the barrel jack cannot handle enough current, so you should instead connect your power supply directly to the Motor Power terminals of the first Chainlink Driver. Make sure you are using the [appropriate wire gauge](https://paper.dropbox.com/doc/Chainlink-Driver-v1.1-Electronics-User-Guide--BWhbqC5xa02TlskitjhIE95eAg-U0DAXrSxEoOhgSoRU39hq#:uid=087574108452977023222089&h2=Power-supply-tips), and [never chain power to more than 6 Chainlink Drivers](https://paper.dropbox.com/doc/Chainlink-Driver-v1.1-Electronics-User-Guide--BWhbqC5xa02TlskitjhIE95eAg-U0DAXrSxEoOhgSoRU39hq#:uid=280278286811718750760936&h2=Large-displays)
https://www.dropbox.com/s/4xpvtycwrw21g0e/chainlinkBuddyWiringv1.1.pdf?dl=0
- ⚠️ For more than 2 Chainlink Drivers, the barrel jack cannot handle enough current, so you should instead connect your power supply directly to the Motor Power terminals of the first Chainlink Driver. Make sure you are using the [appropriate wire gauge](#power-supply-tips), and [never chain power to more than 6 Chainlink Drivers](#large-displays)

[Wiring diagram](img/chainlinkWiringv1.1.pdf)


**Breadboard**

- Connect your power supply directly to the Motor Power terminals of the first Chainlink Driver. Make sure you are using the [appropriate wire gauge](https://paper.dropbox.com/doc/Chainlink-Driver-v1.1-Electronics-User-Guide--BWhbqC5xa02TlskitjhIE95eAg-U0DAXrSxEoOhgSoRU39hq#:uid=087574108452977023222089&h2=Power-supply-tips), and [never chain power to more than 6 Chainlink Drivers](https://paper.dropbox.com/doc/Chainlink-Driver-v1.1-Electronics-User-Guide--BWhbqC5xa02TlskitjhIE95eAg-U0DAXrSxEoOhgSoRU39hq#:uid=280278286811718750760936&h2=Large-displays)
- Connect your power supply directly to the Motor Power terminals of the first Chainlink Driver. Make sure you are using the [appropriate wire gauge](#power-supply-tips), and [never chain power to more than 6 Chainlink Drivers](#large-displays)


https://www.dropbox.com/s/hkv3p7253qu6991/chainlinkWiringv1.1%20%281%29.pdf?dl=0
[Wiring diagram](img/chainlinkWiringv1.1.pdf)



Expand All @@ -194,7 +195,7 @@ You can easily chain several Chainlink Drivers by connecting ribbon cables, and

⚠️ Never chain power to more than 6 Chainlink Drivers in a row ⚠️

The screw terminals have a limited current rating (10A on the ones sold by Bezek Labs), so **using more than 6 Chainlink Drivers will require power to be wired differently**. See [+Chainlink Driver v1.1 Electronics User Guide: Large-displays](https://paper.dropbox.com/doc/Chainlink-Driver-v1.1-Electronics-User-Guide-Large-displays-U0DAXrSxEoOhgSoRU39hq#:uid=280278286811718750760936&h2=Large-displays) below for more info on wiring large displays.
The screw terminals have a limited current rating (10A on the ones sold by Bezek Labs), so **using more than 6 Chainlink Drivers will require power to be wired differently**. See [+Chainlink Driver v1.1 Electronics User Guide: Large-displays](#large-displays) below for more info on wiring large displays.


# 8. (Optional) Standalone T-Display operation
Expand Down Expand Up @@ -239,7 +240,7 @@ https://www.youtube.com/watch?v=g9EPabcxBsM&
![](https://paper-attachments.dropbox.com/s_BBABC117AF455DD9F0525297940CD25AF9A358008ED7FF73463824486BCF5E62_1637358766420_DSC_4994_s.jpg)


The design is open source, so you can order them directly from a PCB manufacturer using the design files provided, but I also [sell them in my Bezek Labs Etsy store](https://www.etsy.com/listing/1123280069/splitflap-chainlink-driver-v11) within the US.
The design is open source, so you can order them directly from a PCB manufacturer using the design files provided, but I also [sell them in my Bezek Labs Etsy store](https://bezeklabs.etsy.com/listing/1123280069/splitflap-chainlink-driver-v11) within the US.

Buying them from my store has the advantage of being [100% functionality tested after assembly using a custom testbed](https://twitter.com/scottbez1/status/1414986069586575360), and it helps support further development and prototyping of this project. I also include all the connectors and a ribbon cable for your convenience.

Expand Down Expand Up @@ -286,8 +287,7 @@ The power should branch into **separate chains of up to 6 Drivers** (or fewer if

Chaining power continuously like the data would overload the screw terminals and wires at the beginning of the chain, potentially causing damage/fire. Note how the yellow and black wires in the diagram below branch *at the power supply* and do not continue past each sub-chain of 6 Drivers.

https://www.dropbox.com/s/i0w7crtejz69kyz/chainlinkWiringAdvanced.pdf?dl=0

[Advanced wiring diagram](img/chainlinkWiringAdvanced.pdf)

I would also strongly recommend adding additional safety measures with a display of this size, considering the total power involved. For instance:

Expand Down
52 changes: 51 additions & 1 deletion docs/MotorGuide.md
Original file line number Diff line number Diff line change
@@ -1 +1,51 @@
Coming soon...
# 28BYJ-48 Motor Buying Guide
[<< Back to Documentation Index](https://paper.dropbox.com/doc/Splitflap-Documentation-Index--BfK6yrHXvLHu_lqLxHSyabHuAg-9t3gJyFBoD3vKI3Tl5VDb)

There are a *lot* of different motors that go by the same “28BYJ-48” name.

If you want to be certain you're getting good motors (and you're in the US), you can opt to add motors to your purchase of a [Chainlink Driver](https://bezeklabs.etsy.com/listing/1123280069/splitflap-chainlink-driver) from the [Bezek Labs](https://bezeklabs.etsy.com) store.
I qualify each batch of motors I receive so you can be sure they'll work great (or I'll replace/refund them).

### Latest AliExpress recommendation (as of 2024-06-25)

As of 2024-06-25, I recommend SeasBoat Store as a fairly reliable AliExpress seller over the last few years, having ordered many hundreds of motors from them myself (but as always, they may send you different motors, so it’s no guarantee).

They have 2 listings available:
- a [“Choice” listing](https://s.click.aliexpress.com/e/_mKVNenq) that is more expensive individually, but qualifies for free shipping over $10 (or use this [non-affiliate link](https://www.aliexpress.us/item/2255800976774653.html)). This may be chepaer for a smaller quantity of motors.
- a [non-Choice listing](https://s.click.aliexpress.com/e/_m0W7bZq) with a lower per-unit cost but with a shipping charge (or use this [non-affiliate link](https://www.aliexpress.us/item/3256807022196320.html)). This is likely cheaper for larger orders.

Make sure you select the “12V” option when adding to your cart!

Depending how many motors you’re ordering and where you are shipping to, you may want to use one listing or the other.

## What's different about different "28BYJ-48" motors?

The two areas of variation are:

- gear ratio
- common values are 16.032:1, 64:1, and 63.68395:1
- coil resistance
- I’ve seen variants ranging from 26 ohms to 185 ohms

(For more background reading, see [Graham Wideman’s detailed post](http://web.archive.org/web/20180528105141/http://grahamwideman.wikispaces.com/Motors-+28BYJ-48+Stepper+motor+notes), though it does not even cover all the variants I have seen)

Both of those factors - gear ratio and coil resistance - have a pretty big impact on output torque, max speed, and control sequence (steps per revolution), but unfortunately most sellers don’t provide that info, or worse, they’ll often provide **incorrect info**.

Making things worse, it’s not uncommon for sellers on AliExpress to change the item they sell without changing the store listing, so even if you’ve purchased from a listing in the past, there’s no guarantee they will continue to offer the same items. This has happened to me with a seller I used previously and no longer recommend.

🔑 The motors that I’ve found work best for splitflap displays have a 64:1 gear ratio and a half-coil-resistance (measured from the red wire to the blue wire) of ~100 ohms.


----------

In my experience, I’ve found these tips improve your chances of getting good motors:


- 🔑 **Only buy motors labeled 12V**
- It seems like there are more variants marketed as “5V” so you’re less likely to get a consistent item when buying 5V motors
- 🔑 **Only buy motors that have laser-engraved labels; avoid motors with sticker labels**
- Laser-engraving is more expensive than stickers, so it generally suggests a higher quality product. I’ve received sticker motors with *identical* “serial” numbers printed on the sticker, whereas the numbers on laser-engraved motors have always been unique in my experience
- 🔑 **Message the seller beforehand to confirm the motors are as you expect**
- Ask whether the motors have a sticker or laser-engraved numbers on the side
- You can try asking what the resistance is, e.g. between the red wire and blue wire, but I’ve had little luck with this in the past (maybe just lost in translation)
- Asking about steps/rev or gear ratio is generally not useful; they will give you an answer but it may not be correct because they can’t easily test it
Binary file added docs/img/chainlinkWiringAdvanced.pdf
Binary file not shown.
Binary file added docs/img/chainlinkWiringv1.1.pdf
Binary file not shown.

0 comments on commit 72367a3

Please sign in to comment.