Update README.md

This commit is contained in:
Zakary Timson 2023-12-05 04:55:21 +00:00
parent 93a1c77112
commit 5f27a57336

117
README.md
View File

@ -1,52 +1,65 @@
<!-- Header -->
<div id="top" align="center">
<br />
<!-- Logo -->
<img src="https://git.zakscode.com/repo-avatars/cfafeecfa694a538cca613976c94203cd48fe506260f6a6b69892545c493b673" alt="Logo" width="200" height="200">
<!-- Title -->
### Animated Cube
<!-- Description -->
Animated 4x4x4 LED cube
<!-- Repo badges -->
[![Version](https://img.shields.io/badge/dynamic/json.svg?label=Version&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/AnimatedCube/tags&query=$[0].name)](https://git.zakscode.com/ztimson/AnimatedCube/tags)
[![Pull Requests](https://img.shields.io/badge/dynamic/json.svg?label=Pull%20Requests&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/AnimatedCube&query=open_pr_counter)](https://git.zakscode.com/ztimson/AnimatedCube/pulls)
</div>
## Table of Contents
- [Animated Cube](#top)
- [About](#about)
- [Built With](#built-with)
- [Demo](#demo)
- [License](#license)
## About
<img src="./gallery/picture.jpg" alt="Logo" width="200" height="200">
<img src="./gallery/Multiplex.svg" alt="Logo" width="200" height="200">
<br />
<br />
This repo contains code for running a 4x4x4 (64 total) LED cube. It uses [multiplexing](https://en.wikipedia.org/wiki/Multiplexing) to control all 64 LEDs using only 20 inputs (4 layers + 16 columns).
4 LED's are wired into columns using their annode. 16 columns are then wired together in a 4x4 square creating a cube. Each vetical layer has its 16 LED cathodes wired together into a plane. By keeping all inputs disconnected, individual LED's can be turned on by connecting the desired column & layer to the positive and negative respectively providing only one complete path for the electricy to follow. Multiple LEDs can be turned on at once by individually blinking each LED faster than the eye can see. By doing this to render multiple "frames" small animations can be created.
Animations are run using an [Arduino Nano](https://store.arduino.cc/products/arduino-nano).
### Built With
[![Arduino](https://img.shields.io/badge/Arduino-00878F?style=for-the-badge&logo=arduino&logoColor=white)](https://www.arduino.cc/)
[![C++](https://img.shields.io/badge/C%2B%2B-00599C?style=for-the-badge&logo=cplusplus)](https://cplusplus.com/)
## Demo
Video of what it looks like: https://www.youtube.com/watch?v=4pzxR-ZhbJA
<ins>**Disclaimer:** I did not create the video but it is made using the same idea</ins>
## License
Copyright © 2023 Zakary Timson | Available under MIT Licensing
See the [license](./LICENSE) for more information.
<!-- Header -->
<div id="top" align="center">
<br />
<!-- Logo -->
<img src="https://git.zakscode.com/repo-avatars/cfafeecfa694a538cca613976c94203cd48fe506260f6a6b69892545c493b673" alt="Logo" width="200" height="200">
<!-- Title -->
### Animated Cube
<!-- Description -->
Animated 4x4x4 LED cube
<!-- Repo badges -->
[![Version](https://img.shields.io/badge/dynamic/json.svg?label=Version&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/animated-cube/tags&query=$[0].name)](https://git.zakscode.com/ztimson/animated-cube/tags)
[![Pull Requests](https://img.shields.io/badge/dynamic/json.svg?label=Pull%20Requests&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/animated-cube&query=open_pr_counter)](https://git.zakscode.com/ztimson/animated-cube/pulls)
[![Issues](https://img.shields.io/badge/dynamic/json.svg?label=Issues&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/animated-cube&query=open_issues_count)](https://git.zakscode.com/ztimson/animated-cube/issues)
<!-- Links -->
---
<div>
<a href="https://git.zakscode.com/ztimson/animated-cube/releases" target="_blank">Release Notes</a>
<a href="https://git.zakscode.com/ztimson/animated-cube/issues/new?template=.github%2fissue_template%2fbug.md" target="_blank">Report a Bug</a>
<a href="https://git.zakscode.com/ztimson/animated-cube/issues/new?template=.github%2fissue_template%2fenhancement.md" target="_blank">Request a Feature</a>
</div>
---
</div>
## Table of Contents
- [Animated Cube](#top)
- [About](#about)
- [Demo](#demo)
- [Built With](#built-with)
- [License](#license)
## About
<img src="./gallery/picture.jpg" alt="Logo" width="200" height="200">
<img src="./gallery/Multiplex.svg" alt="Logo" width="200" height="200">
<br />
<br />
This repo contains code for running a 4x4x4 (64 total) LED cube. It uses [multiplexing](https://en.wikipedia.org/wiki/Multiplexing) to control all 64 LEDs using only 20 inputs (4 layers + 16 columns).
4 LED's are wired into columns using their annode. 16 columns are then wired together in a 4x4 square creating a cube. Each vetical layer has its 16 LED cathodes wired together into a plane. By keeping all inputs disconnected, individual LED's can be turned on by connecting the desired column & layer to the positive and negative respectively providing only one complete path for the electricy to follow. Multiple LEDs can be turned on at once by individually blinking each LED faster than the eye can see. By doing this to render multiple "frames" small animations can be created.
Animations are run using an [Arduino Nano](https://store.arduino.cc/products/arduino-nano).
### Demo
Video of what it looks like: https://www.youtube.com/watch?v=4pzxR-ZhbJA
<ins>**Disclaimer:** I did not create the video but it is made using the same idea</ins>
### Built With
[![Arduino](https://img.shields.io/badge/Arduino-00878F?style=for-the-badge&logo=arduino&logoColor=white)](https://www.arduino.cc/)
[![C++](https://img.shields.io/badge/C%2B%2B-00599C?style=for-the-badge&logo=cplusplus)](https://cplusplus.com/)
## License
Copyright © 2023 Zakary Timson | Available under MIT Licensing
See the [license](./LICENSE) for more information.