Adding Ball busy indicator.

Author: jonathan-meyer

README.md

@@ -1,8 +1,16 @@
 # ArduinoLibrary
+
 A collection of objects and utilities for the Arduino.
 
 * Timer
+    - A class for executing code at a specifict rate without using delays    
 * Button
+    - Add event handlers to physical button like 'click' or 'double click' 
 * Led
+    - fade or flash an led without delays
 * Relay
-* List
+    - control a relay with timing
+* List
+    - A generic template list class
+* Ball 
+    - display a busy indicator

examples/Ball/Ball.ino

@@ -0,0 +1,21 @@
+#include <Ball.h>
+#include <Timer.h>
+
+void wait()
+{
+    Serial.print(Ball);
+}
+
+// The setup function is called once at startup of the sketch
+void setup()
+{
+    Serial.begin(9600);
+
+    Timer.repeat(wait, 500);
+}
+
+// The loop function is called in an endless loop
+void loop()
+{
+    Timer.run();
+}

keywords.txt

@@ -3,3 +3,4 @@ Led	KEYWORD1
 Relay	KEYWORD1
 Timer	KEYWORD1
 Alarm	KEYWORD1
+Ball    KEYWORD1

library.json

@@ -1,6 +1,6 @@
 {
   "name": "ArduinoLibrary",
-  "keywords": "arduino, button, led, list, relay, timer",
+  "keywords": "arduino, button, led, list, relay, timer, wait-indicator, busy-indicator",
   "description": "A collection of objects and utilities for the Arduino.",
   "repository": {
     "type": "git",
@@ -15,7 +15,7 @@
     }
   ],
   "dependencies": [],
-  "version": "2.0.0",
+  "version": "2.1.0",
   "frameworks": "arduino",
   "platforms": ["atmelavr", "espressif"]
 }

library.properties

@@ -1,5 +1,5 @@
 name=ArduinoLibrary
-version=2.0.0
+version=2.1.0
 author=Jonathan Meyer <jon@stejsoftware.com>
 maintainer=Jonathan Meyer <jon@stejsoftware.com>
 sentence=A collection of objects and utilities for the Arduino.

src/Ball.cpp

@@ -0,0 +1,39 @@
+#include "Ball.h"
+
+#define BALL "/-\\|"
+
+BallClass::BallClass() : m_frame(0),
+                         m_auto_delete(false),
+                         m_ball_len(strlen(BALL))
+{
+}
+
+BallClass::~BallClass()
+{
+}
+
+const char BallClass::next() const
+{
+    m_frame = ((m_frame + 1) % m_ball_len);
+    return BALL[m_frame];
+}
+
+size_t BallClass::printTo(Print &p) const
+{
+    p.write(next());
+
+    if (m_auto_delete)
+        p.write(char(8));
+}
+
+void BallClass::setAutoDelete()
+{
+    m_auto_delete = true;
+}
+
+void BallClass::clearAutoDelete()
+{
+    m_auto_delete = false;
+}
+
+BallClass Ball;

src/Ball.h

@@ -0,0 +1,26 @@
+#ifndef _BALL_H
+#define _BALL_H
+
+#include <Arduino.h>
+
+class BallClass : public Printable
+{
+  public:
+    BallClass();
+    ~BallClass();
+
+    size_t printTo(Print &) const;
+    const char next() const;
+
+    void setAutoDelete();
+    void clearAutoDelete();
+
+  private:
+    bool m_auto_delete;
+    uint8_t m_ball_len;
+    mutable uint8_t m_frame;
+};
+
+extern BallClass Ball;
+
+#endif // _BALL_H