Fix #57, comments (#58)

Fix #57, update comments in examples
RobTillaart · Feb 23, 2024 · cd55341 · cd55341
1 parent 6f05b4d
commit cd55341
Show file tree

Hide file tree

Showing 21 changed files with 81 additions and 0 deletions.
diff --git a/examples/AS5600L_set_address/AS5600L_set_address.ino b/examples/AS5600L_set_address/AS5600L_set_address.ino
@@ -3,12 +3,17 @@
 //  AUTHOR: Rob Tillaart
 // PURPOSE: demo
 //     URL: https://github.com/RobTillaart/AS5600
+//
+//  Examples may use AS5600 or AS5600L devices.
+//  Check if your sensor matches the one used in the example.
+//  Optionally adjust the code.
 
 
 #include "AS5600.h"
 
 
 AS5600L ASL;   //  use default Wire
+// AS5600 ASL;   //  use default Wire
 
 
 void setup()

diff --git a/examples/AS5600_I2C_frequency/AS5600_I2C_frequency.ino b/examples/AS5600_I2C_frequency/AS5600_I2C_frequency.ino
@@ -3,6 +3,10 @@
 //  AUTHOR: Rob Tillaart
 // PURPOSE: demo
 //     URL: https://github.com/RobTillaart/AS5600
+//
+//  Examples may use AS5600 or AS5600L devices.
+//  Check if your sensor matches the one used in the example.
+//  Optionally adjust the code.
 
 
 #include "AS5600.h"

diff --git a/examples/AS5600_angular_speed/AS5600_angular_speed.ino b/examples/AS5600_angular_speed/AS5600_angular_speed.ino
@@ -3,6 +3,10 @@
 //  AUTHOR: Rob Tillaart
 // PURPOSE: demo
 //     URL: https://github.com/RobTillaart/AS5600
+//
+//  Examples may use AS5600 or AS5600L devices.
+//  Check if your sensor matches the one used in the example.
+//  Optionally adjust the code.
 
 
 #include "AS5600.h"

diff --git a/examples/AS5600_angular_speed_RPM/AS5600_angular_speed_RPM.ino b/examples/AS5600_angular_speed_RPM/AS5600_angular_speed_RPM.ino
@@ -3,6 +3,10 @@
 //  AUTHOR: Rob Tillaart
 // PURPOSE: demo
 //     URL: https://github.com/RobTillaart/AS5600
+//
+//  Examples may use AS5600 or AS5600L devices.
+//  Check if your sensor matches the one used in the example.
+//  Optionally adjust the code.
 
 
 #include "AS5600.h"

diff --git a/examples/AS5600_burn_conf_mang/AS5600_burn_conf_mang.ino b/examples/AS5600_burn_conf_mang/AS5600_burn_conf_mang.ino
@@ -13,6 +13,10 @@
 //  - uncomment burnSettings() in AS5600.h and AS5600.cpp.
 //  - adjust settings and MaxAngle in burn_mang() function below ==> line 77++
 //  - uncomment line 167 of this sketch
+//
+//  Examples may use AS5600 or AS5600L devices.
+//  Check if your sensor matches the one used in the example.
+//  Optionally adjust the code.
 
 
 #include "AS5600.h"

diff --git a/examples/AS5600_burn_zpos/AS5600_burn_zpos.ino b/examples/AS5600_burn_zpos/AS5600_burn_zpos.ino
@@ -13,6 +13,10 @@
 //  - uncomment burnAngle() in AS5600.h and AS5600.cpp.
 //  - adjust settings and MaxAngle in burn_zpos() function below ==> line 77++
 //  - uncomment line 105 of this sketch
+//
+//  Examples may use AS5600 or AS5600L devices.
+//  Check if your sensor matches the one used in the example.
+//  Optionally adjust the code.
 
 
 #include "AS5600.h"

diff --git a/examples/AS5600_demo/AS5600_demo.ino b/examples/AS5600_demo/AS5600_demo.ino
@@ -3,6 +3,10 @@
 //  AUTHOR: Rob Tillaart
 // PURPOSE: demo
 //     URL: https://github.com/RobTillaart/AS5600
+//
+//  Examples may use AS5600 or AS5600L devices.
+//  Check if your sensor matches the one used in the example.
+//  Optionally adjust the code.
 
 
 #include "AS5600.h"

diff --git a/examples/AS5600_demo_ESP32/AS5600_demo_ESP32.ino b/examples/AS5600_demo_ESP32/AS5600_demo_ESP32.ino
@@ -3,6 +3,10 @@
 //  AUTHOR: Rob Tillaart
 // PURPOSE: demo
 //     URL: https://github.com/RobTillaart/AS5600
+//
+//  Examples may use AS5600 or AS5600L devices.
+//  Check if your sensor matches the one used in the example.
+//  Optionally adjust the code.
 
 
 #include "AS5600.h"

diff --git a/examples/AS5600_demo_RP2040/AS5600_demo_RP2040.ino b/examples/AS5600_demo_RP2040/AS5600_demo_RP2040.ino
@@ -3,6 +3,10 @@
 //  AUTHOR: Rob Tillaart
 // PURPOSE: demo
 //     URL: https://github.com/RobTillaart/AS5600
+//
+//  Examples may use AS5600 or AS5600L devices.
+//  Check if your sensor matches the one used in the example.
+//  Optionally adjust the code.
 
 
 #include "AS5600.h"

diff --git a/examples/AS5600_demo_STM32/AS5600_demo_STM32.ino b/examples/AS5600_demo_STM32/AS5600_demo_STM32.ino
@@ -5,6 +5,10 @@
 //     URL: https://github.com/RobTillaart/AS5600
 //
 //  tested compilation with Nucleo-64
+//
+//  Examples may use AS5600 or AS5600L devices.
+//  Check if your sensor matches the one used in the example.
+//  Optionally adjust the code.
 
 
 #include "AS5600.h"

diff --git a/examples/AS5600_demo_offset/AS5600_demo_offset.ino b/examples/AS5600_demo_offset/AS5600_demo_offset.ino
@@ -3,6 +3,10 @@
 //  AUTHOR: Rob Tillaart
 // PURPOSE: demo
 //     URL: https://github.com/RobTillaart/AS5600
+//
+//  Examples may use AS5600 or AS5600L devices.
+//  Check if your sensor matches the one used in the example.
+//  Optionally adjust the code.
 
 
 #include "AS5600.h"

diff --git a/examples/AS5600_demo_radians/AS5600_demo_radians.ino b/examples/AS5600_demo_radians/AS5600_demo_radians.ino
@@ -3,6 +3,10 @@
 //  AUTHOR: Rob Tillaart
 // PURPOSE: demo
 //     URL: https://github.com/RobTillaart/AS5600
+//
+//  Examples may use AS5600 or AS5600L devices.
+//  Check if your sensor matches the one used in the example.
+//  Optionally adjust the code.
 
 
 #include "AS5600.h"

diff --git a/examples/AS5600_demo_software_direction/AS5600_demo_software_direction.ino b/examples/AS5600_demo_software_direction/AS5600_demo_software_direction.ino
@@ -5,6 +5,10 @@
 //     URL: https://github.com/RobTillaart/AS5600
 //
 //  connect the DIR pin of the AS5600 to GND
+//
+//  Examples may use AS5600 or AS5600L devices.
+//  Check if your sensor matches the one used in the example.
+//  Optionally adjust the code.
 
 
 #include "AS5600.h"

diff --git a/examples/AS5600_demo_status/AS5600_demo_status.ino b/examples/AS5600_demo_status/AS5600_demo_status.ino
@@ -3,6 +3,10 @@
 //  AUTHOR: Rob Tillaart
 // PURPOSE: demo
 //     URL: https://github.com/RobTillaart/AS5600
+//
+//  Examples may use AS5600 or AS5600L devices.
+//  Check if your sensor matches the one used in the example.
+//  Optionally adjust the code.
 
 
 #include "AS5600.h"

diff --git a/examples/AS5600_demo_two_I2C/AS5600_demo_two_I2C.ino b/examples/AS5600_demo_two_I2C/AS5600_demo_two_I2C.ino
@@ -8,6 +8,10 @@
 //  - nano33 ble
 //  - teensy 4.1
 //  - RP2040
+//
+//  Examples may use AS5600 or AS5600L devices.
+//  Check if your sensor matches the one used in the example.
+//  Optionally adjust the code.
 
 
 #include "AS5600.h"

diff --git a/examples/AS5600_outmode_analog_100/AS5600_outmode_analog_100.ino b/examples/AS5600_outmode_analog_100/AS5600_outmode_analog_100.ino
@@ -5,6 +5,8 @@
 //     URL: https://github.com/RobTillaart/AS5600
 //
 //  connect the OUT pin to the analog port of the processor
+//
+//  The AS5600L does not support analog OUT.
 
 
 #include "AS5600.h"

diff --git a/examples/AS5600_outmode_analog_90/AS5600_outmode_analog_90.ino b/examples/AS5600_outmode_analog_90/AS5600_outmode_analog_90.ino
@@ -4,6 +4,8 @@
 // PURPOSE: experimental demo
 //     URL: https://github.com/RobTillaart/AS5600
 //  connect the OUT pin to the analog port of the processor
+//
+//  The AS5600L does not support analog OUT.
 
 
 #include "AS5600.h"

diff --git a/examples/AS5600_outmode_analog_pwm/AS5600_outmode_analog_pwm.ino b/examples/AS5600_outmode_analog_pwm/AS5600_outmode_analog_pwm.ino
@@ -10,6 +10,10 @@
 //
 //  alternative one can read the PWM with interrupt pin and
 //  determine the duty cycle
+//
+//  Examples may use AS5600 or AS5600L devices.
+//  Check if your sensor matches the one used in the example.
+//  Optionally adjust the code.
 
 
 #include "AS5600.h"

diff --git a/examples/AS5600_outmode_pwm_interrupt/AS5600_outmode_pwm_interrupt.ino b/examples/AS5600_outmode_pwm_interrupt/AS5600_outmode_pwm_interrupt.ino
@@ -3,6 +3,10 @@
 //  AUTHOR: Rob Tillaart
 // PURPOSE: demo
 //     URL: https://github.com/RobTillaart/AS5600
+//
+//  Examples may use AS5600 or AS5600L devices.
+//  Check if your sensor matches the one used in the example.
+//  Optionally adjust the code.
 
 
 #include "AS5600.h"

diff --git a/examples/AS5600_position/AS5600_position.ino b/examples/AS5600_position/AS5600_position.ino
@@ -3,6 +3,10 @@
 //  AUTHOR: Rob Tillaart
 // PURPOSE: demo
 //     URL: https://github.com/RobTillaart/AS5600
+//
+//  Examples may use AS5600 or AS5600L devices.
+//  Check if your sensor matches the one used in the example.
+//  Optionally adjust the code.
 
 
 #include "AS5600.h"

diff --git a/examples/AS5600_resetCumulativeCounter/AS5600_resetCumulativeCounter.ino b/examples/AS5600_resetCumulativeCounter/AS5600_resetCumulativeCounter.ino
@@ -3,6 +3,10 @@
 //  AUTHOR: Daniel-Frenkel, (slightly by Rob Tillaart)
 // PURPOSE: demo - see issue #30
 //     URL: https://github.com/RobTillaart/AS5600
+//
+//  Examples may use AS5600 or AS5600L devices.
+//  Check if your sensor matches the one used in the example.
+//  Optionally adjust the code.
 
 
 #include "AS5600.h"