Skip to content

Commit

Permalink
FEAT added more complete readme
Browse files Browse the repository at this point in the history
  • Loading branch information
askuric committed Sep 21, 2020
1 parent 285b02e commit 5d98a75
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 3 deletions.
24 changes: 21 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Arduino *Simple**FOC**Shield* *v1.3.2*

This is an open-source low-cost Brushless DC (BLDC) motor driver board intended primarily for low-power FOC applications up to 5Amps. The board is fully compatible with the Arduino UNO and all the boards with the standard Arduino headers. The SimpleFOCShield, in combination with the SimpleFOClibrary provides user-friendly way to control BLDC motors both in hardware and software.

<p align="">
<a href="https://youtu.be/G5pbo0C6ujE">
<img src="https://docs.simplefoc.com/extras/Images/foc_shield_video.jpg" height="320px">
</a>
<img src="images/top.png" height="320px"><img src="images/bottom.png" height="320px">
</p>

### Features
Expand All @@ -19,3 +19,21 @@

### New Features
- **I2C interface**: Integrated 4.7kΩ pullups (configurable)

### Short YouTube demonstration video :D
<p align="">
<a href="https://youtu.be/G5pbo0C6ujE">
<img src="https://docs.simplefoc.com/extras/Images/foc_shield_video.jpg" height="320px">
</a>
</p>

## Getting started

You already have your own <span class="simple">Simple<span class="foc">FOC</span>Shield</span>? <br>
[Here is a simple guide how to start preparing your setup](arduino_simplefoc_shield_getting_started)



## How to get hold of the <span class="simple">Simple<span class="foc">FOC</span>Shield</span>
- **Fabricate the board yourself**: Please visit the [board fabrication](https://docs.simplefoc.com/arduino_simplefoc_shield_fabrication) to find out how to manufacture the board yourself!<br>
- **Order the finished and tested board**: Check out our [shop](https://simplefoc.com/simplefoc_shield_product).
Binary file modified altium project/SimpleFOCShield_v1.3.2.zip
Binary file not shown.
Binary file added images/bottom.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/top.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5d98a75

Please sign in to comment.