Added stepper abstraction draft (#9)

main/CMakeLists.txt

@@ -1,2 +1,2 @@
 idf_component_register(SRCS "app_main.cpp"
-                    INCLUDE_DIRS ".")
+                    INCLUDE_DIRS "." "include")

main/app_main.cpp

@@ -36,6 +36,8 @@
 
 #include "cJSON.h"
 
+#include "stepper_api.h"
+
 #if !(CONFIG_HCC_ESP32_ONE_WIRE_ENABLE || CONFIG_HCC_ESP32_A4988_ENABLE)
 #error "No components enabled, configuration doesn't make sense. Run 'idf.py menuconfig' to enable."
 #endif

main/include/stepper_api.h

@@ -0,0 +1,57 @@
+#ifndef _HCC_ESP32_STEPPER_API_H_
+#define _HCC_ESP32_STEPPER_API_H_
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+namespace stepper {
+
+enum class Direction {
+    down = -1,
+    up = 1
+};
+
+class Stepper {
+public:
+
+    virtual ~Stepper() = 0;
+
+    /**
+     * Move the stepper in the specified direction, and return the current position.
+     */
+    virtual int step(Direction d) = 0;
+
+    /**
+     * Returns max supported microstepping divider, or 0 if microstepping is not supported.
+     */
+    virtual int getMaxMicrostep() = 0;
+
+    /**
+     * Returns currently used microstepping divider.
+     *
+     * NOTE: if microstepping is not supported, return value is 1, as a syntax sugar.
+     */
+    virtual int getMicrostep() = 0;
+
+    /**
+     * Set microstepping to the specified divider.
+     *
+     * Returns the provided value if set successfully, 0 if microstepping is not enabled by configuration,
+     * -1 if microstepping not supported, and -2 if the given value is not supported.
+     */
+    virtual int setMicrostep(int divider) = 0;
+
+    /**
+     * Put the controller to sleep with {@code true}, wake up with {@code false}.
+     *
+     * Returns {@code true} if the controller supports this operation.
+     */
+    virtual bool powerSave(bool enable) = 0;
+};
+}
+#ifdef __cplusplus
+}
+#endif //__cplusplus
+
+#endif