Skip to content

Commit 817f459

Browse files
authored
Update README.md
1 parent bb70738 commit 817f459

File tree

1 file changed

+15
-33
lines changed

1 file changed

+15
-33
lines changed

README.md

Lines changed: 15 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -95,38 +95,18 @@ This video demonstrates the *Simple**FOC**library* basic usage, electronic conne
9595

9696
<p align=""> <img src="https://docs.simplefoc.com/extras/Images/uno_l6234.jpg" height="170px"> <img src="https://docs.simplefoc.com/extras/Images/hmbgc_v22.jpg" height="170px"> <img src="https://docs.simplefoc.com/extras/Images/foc_shield_v13.jpg" height="170px"></p>
9797

98-
## Arduino *SimpleFOCShield* v2.0.4
99-
<p align="">
100-
<a href="https://youtu.be/G5pbo0C6ujE">
101-
<img src="https://docs.simplefoc.com/extras/Images/foc_shield_video.jpg" height="320px">
102-
</a>
103-
</p>
10498

105-
### Features
106-
- **Plug & play**: In combination with Arduino *Simple**FOC**library* - [github](https://github.com/simplefoc/Arduino-FOC)
107-
- **Low-cost**: Price of €15 - [Check the pricing](https://www.simplefoc.com/shop)
108-
- **In-line current sensing**: Up to 3Amps/5Amps bidirectional
109-
- configurable: 3.3Amps - 3.3V adc, 5Amps - 5V adc
110-
- **Integrated 8V regulator**:
111-
- Enable/disable by soldering pads
112-
- **Max power 120W** - max current 5A, power-supply 12-24V
113-
- Designed for Gimbal motors with the internal resistance >10 Ωs.
114-
- **Stackable**: running 2 motors in the same time
115-
- **Encoder/Hall sensors interface**: Integrated 3.3kΩ pullups (configurable)
116-
- **I2C interface**: Integrated 4.7kΩ pullups (configurable)
117-
- **Configurable pinout**: Hardware configuration - soldering connections
118-
- **Arduino headers**: Arduino UNO, Arduino MEGA, STM32 Nucleo boards...
119-
- **Open Source**: Fully available fabrication files - [how to make it yourself](https://docs.simplefoc.com/arduino_simplefoc_shield_fabrication)
120-
121-
<p align=""><img src="https://simplefoc.com/assets/img/v2.jpg" height="180px"> <img src="https://simplefoc.com/assets/img/v1.jpg" height="180px"> <img src="https://docs.simplefoc.com/extras/Images/simple_foc_shield_v13_small.gif" height="180x"></p>
99+
## Documentation
100+
Full API code documentation as well as example projects and step by step guides can be found on our [docs website](https://docs.simplefoc.com/).
122101

102+
![image](https://user-images.githubusercontent.com/36178713/168475410-105e4e3d-082a-4015-98ff-d380c7992dfd.png)
123103

124104

125105
## Getting Started
126106
Depending on if you want to use this library as the plug and play Arduino library or you want to get insight in the algorithm and make changes there are two ways to install this code.
127107

128108
- Full library installation [Docs](https://docs.simplefoc.com/library_download)
129-
- Minimal project builder [Docs](https://docs.simplefoc.com/minimal_download)
109+
- PlatformIO [Docs](https://docs.simplefoc.com/library_platformio)
130110

131111
### Arduino *SimpleFOClibrary* installation to Arduino IDE
132112
#### Arduino Library Manager
@@ -149,14 +129,19 @@ git clone https://github.com/simplefoc/Arduino-FOC.git
149129
```
150130
- Reopen Arduino IDE and you should have the library examples in `File > Examples > Simple FOC`.
151131

152-
### *SimpleFOClibrary* minimal project builder
132+
## Community and contributing
153133

154-
For those willing to experiment and to modify the code I suggest using the minimal project builder [minimal branch](https://github.com/simplefoc/Arduino-FOC/tree/minimal).
155-
> This code is completely independent and you can run it as any other Arduino Sketch without the need for any libraries.
134+
For all the questions regarding the potential implementation, applications, supported hardware and similar please visit our [community forum](https://community.simplefoc.com) or our [discord server](https://discord.gg/kWBwuzY32n).
156135

157-
All you need to do is:
158-
- Go to [minimal branch](https://github.com/simplefoc/Arduino-FOC/tree/minimal)
159-
- Follow the tutorial in the README file and choose only the library files that are necessary for your application.
136+
It is always helpful to hear the stories/problems/suggestions of people implementing the code and you might find a lot of answered questions there already!
137+
138+
### Github Issues & Pull requests
139+
140+
Please do not hesitate to leave an issue if you have problems/advices/suggestions regarding the code!
141+
142+
Pull requests are welcome, but let's first discuss them in [community forum](https://community.simplefoc.com)!
143+
144+
If you'd like to contribute to this porject but you are not very familiar with github, don't worry, let us know either by posting at the community forum , by posting a github issue or at our discord server.
160145

161146
## Arduino code example
162147
This is a simple Arduino code example implementing the velocity control program of a BLDC motor with encoder.
@@ -230,9 +215,6 @@ Here are some of the *Simple**FOC**library* and *Simple**FOC**Shield* applicatio
230215
</p>
231216

232217

233-
## Documentation
234-
Find out more information about the Arduino SimpleFOC project in [docs website](https://docs.simplefoc.com/)
235-
236218

237219
## Arduino FOC repo structure
238220
Branch | Description | Status

0 commit comments

Comments
 (0)