https://github.com/espressif/arduino-foc

Arduino FOC for BLDC and Stepper motors - Arduino Based Field Oriented Control Algorithm Library
https://github.com/espressif/arduino-foc

Last synced: 2 days ago
JSON representation

Arduino FOC for BLDC and Stepper motors - Arduino Based Field Oriented Control Algorithm Library

• Host: GitHub
• URL: https://github.com/espressif/arduino-foc
• Owner: espressif
• License: mit
• Fork: true (simplefoc/Arduino-FOC)
• Created: 2023-07-10T06:08:35.000Z (about 1 year ago)
• Default Branch: esp_based_on_v2.3.0
• Last Pushed: 2024-08-14T10:47:38.000Z (about 1 month ago)
• Last Synced: 2024-09-23T15:32:46.716Z (3 days ago)
• Homepage: https://docs.simplefoc.com
• Size: 9.98 MB
• Stars: 8
• Watchers: 2
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Citation: CITATION.cff

Awesome Lists containing this project

README

        
# Espressif Arduino-FOC Fork

This is a fork of upstream [Arduino-FOC](https://github.com/simplefoc/Arduino-FOC) with integration into ESP-IDF build system.

This fork repository is wrapped as an ESP-IDF component, which offers the algorithm implementation of FOC (Field Oriented Control) for BLDC and stepper motors.

To drive the motors, you need to use this component together with [esp_simplefoc](https://github.com/espressif/esp-iot-solution/tree/master/components/motor/esp_simplefoc), which offers the hardware drivers for motors.

## Supported SoCs

The driver supports all ESP chips with `LEDC` or `MCPWM` peripherals, please refer to [esp_simplefoc](https://github.com/espressif/esp-iot-solution/tree/master/components/motor/esp_simplefoc) for details.

## How to use

### Use this component together with [esp_simplefoc](https://github.com/espressif/esp-iot-solution/tree/master/components/motor/esp_simplefoc).

Just add ``idf_component.yml`` to your main component with the following content::

```yaml

## IDF Component Manager Manifest File

dependencies:

  esp_simplefoc: "*"

```

Or simply run:

```

idf.py add-dependency "esp_simplefoc"

```

## API Documentation

1. Library introduction can be found on [README](https://github.com/simplefoc/Arduino-FOC/blob/master/README.md) from the upstream Arduino-FOC.

2. Full API code documentation as well as example projects and step by step guides can be found on [SimpleFOC Docs Website](https://docs.simplefoc.com/).