Skip to content

Commit ff2fb84

Browse files
committed
update simplefocnanodriver docs
1 parent 9952f3b commit ff2fb84

File tree

2 files changed

+15
-1
lines changed

2 files changed

+15
-1
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
.project
22
.DS_Store
3+
src/encoders/esp32hwencoder.bak/

src/drivers/simplefocnano/README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ void loop(){
3131
}
3232
```
3333

34+
### Additional functions
35+
3436
There are some extra features, you can check for faults, and clear the fault state:
3537

3638
```c++
@@ -50,6 +52,8 @@ if (driver.isSleeping())
5052
driver.wake();
5153
```
5254

55+
### Bus Voltage Sense
56+
5357
As shown in the example you can read the bus voltage:
5458

5559
:warning: *this is a slow function. Do not call it while motor is running!*
@@ -58,8 +62,17 @@ As shown in the example you can read the bus voltage:
5862
float val = driver.getBusVoltage(); // get the bus voltage, in Volts
5963
```
6064

65+
### SPI port
66+
6167
The driver's nCS pin is 10, and the constant PIN_nCS can be used:
6268

6369
```c++
6470
MagneticSensorAS5048A sensor = MagneticSensorAS5048A(PIN_nCS);
65-
```
71+
```
72+
73+
## Examples
74+
75+
The following examples for SimpleFOCNanoDriver can be found in our examples directory:
76+
77+
- [SimpleFOC Nano on AVR](https://github.com/simplefoc/Arduino-FOC-drivers/blob/master/examples/drivers/simplefocnano/simplefocnano_atmega/simplefocnano_atmega.ino) (5V, 10bit ADC range, like original Nano, using AS5048A sensor on SPI)
78+
- [SimpleFOCNanoDriver torque-voltage mode](https://github.com/simplefoc/Arduino-FOC-drivers/blob/master/examples/drivers/simplefocnano/simplefocnano_torque_voltage/simplefocnano_torque_voltage.ino) (3.3V, 12bit ADC range, using AS5048A sensor on SPI)

0 commit comments

Comments
 (0)