From ea80a48a4ace1ee311564d2a8283017267bee63c Mon Sep 17 00:00:00 2001 From: Rob Tillaart Date: Mon, 19 Jun 2023 19:33:01 +0200 Subject: [PATCH] improve comments --- .../AS5600_burn_conf_mang.ino | 8 +++++--- examples/AS5600_burn_zpos/AS5600_burn_zpos.ino | 14 ++++++++------ 2 files changed, 13 insertions(+), 9 deletions(-) diff --git a/examples/AS5600_burn_conf_mang/AS5600_burn_conf_mang.ino b/examples/AS5600_burn_conf_mang/AS5600_burn_conf_mang.ino index 2d5b3e8..f814181 100644 --- a/examples/AS5600_burn_conf_mang/AS5600_burn_conf_mang.ino +++ b/examples/AS5600_burn_conf_mang/AS5600_burn_conf_mang.ino @@ -1,17 +1,19 @@ // // FILE: AS5600_burn_conf_mang.ino // AUTHOR: Rob Tillaart -// PURPOSE: demo +// PURPOSE: demo (not tested yet - see issue #38) // DATE: 2023-06-18 // WARNING // As burning the settings can only be done once this sketch has to be used with care. // -// You need to +// You need to +// - read the datasheet so you understand what you do +// - read issue #38 to understand the discussion that lead to this sketch // - uncomment burnSettings() in AS5600.h and AS5600.cpp. // - adjust settings and MaxAngle in burn_mang() function below ==> line 77++ -// - uncomment line 167 +// - uncomment line 167 of this sketch #include "AS5600.h" diff --git a/examples/AS5600_burn_zpos/AS5600_burn_zpos.ino b/examples/AS5600_burn_zpos/AS5600_burn_zpos.ino index a1d1d55..0225269 100644 --- a/examples/AS5600_burn_zpos/AS5600_burn_zpos.ino +++ b/examples/AS5600_burn_zpos/AS5600_burn_zpos.ino @@ -1,17 +1,19 @@ // -// FILE: AS5600_burn_conf_mang.ino +// FILE: AS5600_zpos.ino // AUTHOR: Rob Tillaart -// PURPOSE: demo +// PURPOSE: demo (not tested yet - see issue #38) // DATE: 2023-06-18 // WARNING -// As burning the settings can only be done once this sketch has to be used with care. +// As burning the angle can only be done three times this sketch has to be used with care. // -// You need to -// - uncomment burnSettings() in AS5600.h and AS5600.cpp. +// You need to +// - read the datasheet so you understand what you do +// - read issue #38 to understand the discussion that lead to this sketch +// - uncomment burnAngle() in AS5600.h and AS5600.cpp. // - adjust settings and MaxAngle in burn_zpos() function below ==> line 77++ -// - uncomment line 105 +// - uncomment line 105 of this sketch #include "AS5600.h"