Initial commit

.gitignore

@@ -0,0 +1,5 @@
+.pio
+.vscode/.browse.c_cpp.db*
+.vscode/c_cpp_properties.json
+.vscode/launch.json
+.vscode/ipch

.vscode/extensions.json

@@ -0,0 +1,10 @@
+{
+    // See http://go.microsoft.com/fwlink/?LinkId=827846
+    // for the documentation about the extensions.json format
+    "recommendations": [
+        "platformio.platformio-ide"
+    ],
+    "unwantedRecommendations": [
+        "ms-vscode.cpptools-extension-pack"
+    ]
+}

include/FlipFlat.h

@@ -0,0 +1,94 @@
+#ifndef __FLIPFLAT_H__
+#define __FLIPFLAT_H__
+
+#include <Arduino.h>
+
+#include <Streaming.h>
+#include <EasyButton.h>
+#include <AccelStepper.h>
+
+#define DEBUG       0
+
+#ifdef ESP32
+#define BRIGHT_PLUS GPIO_NUM_34
+#define BRIGHT_MIN  GPIO_NUM_35
+#define PWM         GPIO_NUM_25  
+#define OPEN_FF     GPIO_NUM_36
+#define CLOSE_FF    GPIO_NUM_39
+#define STEP_PIN    GPIO_NUM_32
+#define DIR_PIN     GPIO_NUM_33
+
+#define FF_SERIAL   Serial2
+#define LOG_SERIAL  Serial
+#endif
+
+//#ifdef ARDUINO_AVR_LEONARDO
+#define BRIGHT_PLUS 15 
+#define BRIGHT_MIN  14
+#define PWM         9  
+#define COVER_FF    16
+#define STEP_PIN    7
+#define DIR_PIN     8
+
+#define FF_SERIAL   Serial  
+#define LOG_SERIAL  Serial1
+
+//#endif
+
+#define STEPS       200 // steps per revolution for the motor
+
+enum devices {
+  FLAT_MAN_L = 10,
+  FLAT_MAN_XL = 15,
+  FLAT_MAN = 19,
+  FLIP_FLAT = 99
+};
+
+enum motorStatuses {
+  STOPPED = 0,
+  RUNNING
+};
+
+enum lightStatuses {
+  OFF = 0,
+  ON
+};
+
+enum shutterStatuses {
+  NEITHER_OPEN_NOR_CLOSED = 0, // ie not open or closed...could be moving
+  CLOSED,
+  OPEN,
+  TIMED_OUT
+};
+
+enum motorDirections {
+  OPENING = 0,
+  CLOSING,
+  NONE
+};
+
+void setupSerial();
+void handleSerial();
+void handleCoverSwitch();
+
+void increaseBrightness();
+void decreaseBrightness();
+void setBrightness(int newBrightness);
+void openFlipFlat();
+void closeFlipFlat();
+void rotateMotor(float newAngle);
+
+void processCommand(const char* cmd, const char *data);
+void parseCommand();
+
+#if DEBUG
+#ifndef LOG
+#define LOG(A) LOG_SERIAL << F(A) << endl
+#define LOG1(A, B) LOG_SERIAL << F(A) << B << endl;
+#endif
+#else
+#define LOG(A)
+#define LOG1(A, B)
+#endif //DEBUG
+
+#endif //__FLIPFLAT_H__

include/README

@@ -0,0 +1,39 @@
+
+This directory is intended for project header files.
+
+A header file is a file containing C declarations and macro definitions
+to be shared between several project source files. You request the use of a
+header file in your project source file (C, C++, etc) located in `src` folder
+by including it, with the C preprocessing directive `#include'.
+
+```src/main.c
+
+#include "header.h"
+
+int main (void)
+{
+ ...
+}
+```
+
+Including a header file produces the same results as copying the header file
+into each source file that needs it. Such copying would be time-consuming
+and error-prone. With a header file, the related declarations appear
+in only one place. If they need to be changed, they can be changed in one
+place, and programs that include the header file will automatically use the
+new version when next recompiled. The header file eliminates the labor of
+finding and changing all the copies as well as the risk that a failure to
+find one copy will result in inconsistencies within a program.
+
+In C, the usual convention is to give header files names that end with `.h'.
+It is most portable to use only letters, digits, dashes, and underscores in
+header file names, and at most one dot.
+
+Read more about using header files in official GCC documentation:
+
+* Include Syntax
+* Include Operation
+* Once-Only Headers
+* Computed Includes
+
+https://gcc.gnu.org/onlinedocs/cpp/Header-Files.html

lib/README

@@ -0,0 +1,46 @@
+
+This directory is intended for project specific (private) libraries.
+PlatformIO will compile them to static libraries and link into executable file.
+
+The source code of each library should be placed in a an own separate directory
+("lib/your_library_name/[here are source files]").
+
+For example, see a structure of the following two libraries `Foo` and `Bar`:
+
+|--lib
+|  |
+|  |--Bar
+|  |  |--docs
+|  |  |--examples
+|  |  |--src
+|  |     |- Bar.c
+|  |     |- Bar.h
+|  |  |- library.json (optional, custom build options, etc) https://docs.platformio.org/page/librarymanager/config.html
+|  |
+|  |--Foo
+|  |  |- Foo.c
+|  |  |- Foo.h
+|  |
+|  |- README --> THIS FILE
+|
+|- platformio.ini
+|--src
+   |- main.c
+
+and a contents of `src/main.c`:
+```
+#include <Foo.h>
+#include <Bar.h>
+
+int main (void)
+{
+  ...
+}
+
+```
+
+PlatformIO Library Dependency Finder will find automatically dependent
+libraries scanning project source files.
+
+More information about PlatformIO Library Dependency Finder
+- https://docs.platformio.org/page/librarymanager/ldf.html

platformio.ini

@@ -0,0 +1,27 @@
+; PlatformIO Project Configuration File
+;
+;   Build options: build flags, source filter
+;   Upload options: custom upload port, speed and extra flags
+;   Library options: dependencies, extra library storages
+;   Advanced options: extra scripting
+;
+; Please visit documentation for the other options and examples
+; https://docs.platformio.org/page/projectconf.html
+
+[env]
+lib_deps = 
+	https://github.com/janelia-arduino/Streaming.git
+	evert-arias/EasyButton@^2.0.1
+	waspinator/AccelStepper@^1.64
+
+[env:ESP32]
+platform = espressif32
+board = esp32doit-devkit-v1
+framework = arduino
+
+[env:arduino_pro_micro]
+board = sparkfun_promicro16
+platform = atmelavr
+framework = arduino
+
+

src/FlipFlat.cpp

@@ -0,0 +1,328 @@
+// FlipFlat based on the Altinak Flip-Flat commands. Makes it possible to use it with ASCOM and INDI drivers
+
+// Enable DEBUG in FlipFlat.h to see logging.
+// Due to driver imitations in de indi driver, when using ESP32 Serial can't be used for FlipFlat communication. 
+// Use Serial 2 (pins 16 and 17) instead. Standard Serial is used for debug messages
+
+#include <FlipFlat.h>
+
+int deviceId = FLIP_FLAT; // set this to FLAT_MAN if you want to remove or not use the motor handling
+int motorStatus = STOPPED;
+int lightStatus = OFF;
+int coverStatus = CLOSED;
+int motorDirection = NONE;
+float currentAngle = 0.0;
+
+int brightness = 0;
+
+EasyButton brightness_plus(BRIGHT_PLUS);
+EasyButton brightness_min(BRIGHT_MIN);
+EasyButton cover_control(COVER_FF);
+
+AccelStepper stepper(AccelStepper::DRIVER, STEP_PIN, DIR_PIN);
+
+void setup()
+{
+  setupSerial();
+
+  LOG("Debug mode");
+  LOG("Starting FlipFlat");
+  LOG("Setup PWM pin");
+
+  pinMode(PWM, OUTPUT);
+
+  LOG("Setup brightness buttons");
+
+  brightness_plus.begin();
+  brightness_plus.onPressed(increaseBrightness);
+  brightness_min.begin();
+  brightness_min.onPressed(decreaseBrightness);
+
+  LOG("Setup open-close button");
+
+  cover_control.begin();
+  cover_control.onPressed(handleCoverSwitch);
+
+  LOG("Initializing stepper");
+
+  stepper.setMaxSpeed(1000);
+  stepper.setAcceleration(50);
+  stepper.setSpeed(200);
+  stepper.moveTo(STEPS);
+}
+
+void loop()
+{
+  brightness_plus.read();
+  brightness_min.read();
+  cover_control.read();
+
+  if (FF_SERIAL.available() > 0) // all incoming communications are fixed length at 6 bytes including the \r
+  {
+    LOG("Command received");
+    parseCommand();
+  }
+}
+
+void increaseBrightness()
+{
+  LOG("Brightness+ is pressed");
+
+  brightness++;
+
+  setBrightness(brightness);
+}
+
+void decreaseBrightness()
+{
+  LOG("Brightness- is pressed");
+
+  brightness--;
+
+  setBrightness(brightness);
+}
+
+void setBrightness(int newBrightness)
+{
+  LOG1("Setting brightness to ", newBrightness);
+
+  analogWrite(PWM, newBrightness);
+}
+
+void parseCommand()
+{
+  LOG("Parse command");
+
+  char *cmd;
+  char *data;
+
+  char str[20];
+  memset(str, 0, 20);
+
+  FF_SERIAL.readBytesUntil('\n', str, 20);
+
+  cmd = str + 1;
+  data = str + 2;
+
+  // useful for debugging to make sure your commands came through and are parsed correctly.
+  LOG1("cmd = ", cmd);
+  LOG1("data = ", data);
+
+  processCommand(cmd, data);
+
+  while (FF_SERIAL.available() > 0)
+    FF_SERIAL.read();
+}
+
+void processCommand(const char *cmd, const char *data)
+{
+  switch (*cmd)
+  {
+    /*
+    Ping device
+      Request: >POOO\r
+      Return : *PiiOOO\n
+        ii = DEVICE_ID
+    */
+  case 'P':
+    LOG("Ping received");
+    FF_SERIAL << F("*P") << deviceId << F("OOO\n");
+    break;
+
+  /*
+  Open shutter
+  Request: >OOOO\r
+  Return : *OiiOOO\n
+    ii = deviceId
+  This command is only supported on the Flip-Flat!
+  */
+  case 'O':
+    LOG("Open received");
+    FF_SERIAL << F("*O") << deviceId << F("OOO\n");
+    openFlipFlat();
+    break;
+
+  /*
+  Close shutter
+  Request: >COOO\r
+  Return : *CiiOOO\n
+    ii = deviceId
+  This command is only supported on the Flip-Flat!
+  */
+  case 'C':
+    LOG("Close received");
+    FF_SERIAL << F("*C") << deviceId << F("OOO\n");
+    closeFlipFlat();
+    break;
+
+  /*
+  Turn light on
+    Request: >LOOO\r
+    Return : *LiiOOO\n
+      ii = deviceId
+    */
+  case 'L':
+    LOG("Turn on received");
+    FF_SERIAL << F("*L") << deviceId << F("OOO\n");
+    lightStatus = ON;
+    setBrightness(brightness);
+    break;
+
+    /*
+    Turn light off
+      Request: >DOOO\r
+      Return : *DiiOOO\n
+        id = deviceId
+    */
+  case 'D':
+    LOG("Turn off received");
+    FF_SERIAL << F("*D") << deviceId << F("OOO\n");
+    lightStatus = OFF;
+    setBrightness(0);
+    break;
+
+    /*
+    Set brightness
+      Request: >Bxxx\r
+        xxx = brightness value from 000-255
+      Return : *Bidyyy\n
+        id = deviceId
+        yyy = value that brightness was set from 000-255
+    */
+  case 'B':
+    LOG("Set brightness received");
+    FF_SERIAL << F("*B") << deviceId << _WIDTHZ(brightness, 3) << F("\n");
+
+    brightness = atoi(data);
+
+    if (lightStatus == ON)
+      setBrightness(brightness);
+
+    break;
+
+    /*
+    Get brightness
+      Request: >J000\r
+      Return : *Jiiyyy\n
+        id = deviceId
+        yyy = current brightness value from 000-255
+    */
+  case 'J':
+    LOG("Get brightness received");
+    FF_SERIAL << F("*J") << deviceId << _WIDTHZ(brightness, 3) << F("\n");
+    break;
+
+    /*
+    Get device status:
+      Request: >S000\r
+      Return : *SiiMLC\n
+        ii = deviceId
+        M  = motor status( 0 stopped, 1 running)
+        L  = light status( 0 off, 1 on)
+        C  = Cover Status( 0 moving, 1 closed, 2 open)
+    */
+  case 'S':
+    LOG("Get status recived");
+    FF_SERIAL << F("*S") << deviceId << motorStatus << lightStatus << coverStatus << F("\n");
+    break;
+
+    /*
+    Get firmware version
+      Request: >V000\r
+      Return : *Vii001\n
+        ii = deviceId
+    */
+  case 'V': // get firmware version
+    LOG("Get firmware version received");
+    FF_SERIAL << F("*V") << deviceId << F("001") << F("\n");
+    break;
+  }
+}
+
+void openFlipFlat()
+{
+  if (coverStatus != OPEN)
+  {
+    LOG("Turn light off");
+    setBrightness(0);
+
+    motorDirection = OPENING;
+    rotateMotor(270.0);
+  }
+}
+
+void closeFlipFlat()
+{
+  LOG("Closing FlipFlat");
+  if (coverStatus != CLOSED)
+  {
+    motorDirection = CLOSING;
+    rotateMotor(270.0);
+  }
+  else
+  {
+    LOG("FlipFlap already closed");
+  }
+}
+
+void rotateMotor(float newAngle)
+{
+  if (motorDirection == OPENING)
+  {
+    motorStatus = RUNNING;
+    coverStatus = NEITHER_OPEN_NOR_CLOSED;
+
+    stepper.move(STEPS * newAngle / 360.0);
+    stepper.runToPosition();
+
+    coverStatus = OPEN;
+  }
+  else
+  {
+    if (motorDirection == CLOSING)
+    {
+      motorStatus = RUNNING;
+      coverStatus = NEITHER_OPEN_NOR_CLOSED;
+
+      stepper.move(-STEPS * newAngle / 360.0);
+      stepper.runToPosition();
+
+      coverStatus = CLOSED;
+    }
+  }
+  motorStatus = STOPPED;
+  motorDirection = NONE;
+}
+
+void setupSerial()
+{
+
+#ifdef ESP32
+  FF_SERIAL.begin(9600, SERIAL_8N1, 16, 17);
+  LOG_SERIAL.begin(9600);
+#endif
+
+#ifdef ARDUINO_AVR_LEONARDO
+  FF_SERIAL.begin(9600);
+  LOG_SERIAL.begin(9600);
+#endif
+
+  LOG("Logging serial up and running");
+  LOG("FlipFlat Serial up and running");
+
+}
+
+void handleCoverSwitch(){
+  switch (coverStatus){
+ case CLOSED:
+    LOG("Opening cover");
+    openFlipFlat();
+    break;
+  case OPEN:
+    LOG("Closing cover");
+    closeFlipFlat();
+    break;
+  default:
+    LOG("Cover not open or closed");
+  }
+}

test/README

@@ -0,0 +1,11 @@
+
+This directory is intended for PlatformIO Test Runner and project tests.
+
+Unit Testing is a software testing method by which individual units of
+source code, sets of one or more MCU program modules together with associated
+control data, usage procedures, and operating procedures, are tested to
+determine whether they are fit for use. Unit testing finds problems early
+in the development cycle.
+
+More information about PlatformIO Unit Testing:
+- https://docs.platformio.org/en/latest/advanced/unit-testing/index.html