Skip to content

Commit

Permalink
SerialUI version 1.4.0
Browse files Browse the repository at this point in the history
Changes:
 * 0-delay checkForUser() -- call can now be made with "0" timeout,
   and will return immediately with answer.

 * Library re-organization, for automated imports using Arduino
   IDE Library Manager.

 * Supported platforms now include
	SUI_PLATFORM_ARDUINOSTANDARD (most Arduino/Arduino-compatible)

	SUI_PLATFORM_ARDUINO_DUE (Due)

	SUI_PLATFORM_RBLNRF51822 (nRF51822-centered Arduino SDK, by
	RedBearLab, for things like the BLE Nano
        http://redbearlab.com/blenano/)

Coming soon: v2, with new organization to allow some nifty new stuff, and support for an updated Druid4Arduino.
  • Loading branch information
psychogenic committed Jan 8, 2016
1 parent 23aa480 commit dd9f508
Show file tree
Hide file tree
Showing 26 changed files with 624 additions and 301 deletions.
51 changes: 0 additions & 51 deletions INSTALL.txt

This file was deleted.

36 changes: 36 additions & 0 deletions extras/INSTALL.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
SerialUI Installation

SerialUI: Serial User Interface.
Copyright (C) 2013-2016 Pat Deegan. All rights reserved.
http://flyingcarsandstuff.com/projects/SerialUI/


If you're using the Arduino IDE and building for
Arduino, the installation procedure is the same
as for any library and is described fully at:

http://arduino.cc/en/Guide/Libraries

The short version is: SerialUI now supports imports into
the set of libraries directly as a zip file. Simply
download the SerialUI-x.x.x.zip file and then, from
within the Arduino IDE, select

Sketch -> Include Library -> Add .ZIP library

and select the SerialUI file.


Do have a look at the

File -> Examples -> SerialUI -> SuperBlinker

example, the README.txt and/or the SerialUI.h header
file.

For other platforms/dev environments, just include
the contents of the SerialUI directory wherever
appropriate ;-)

Pat Deegan, psychogenic.com

File renamed without changes.
157 changes: 0 additions & 157 deletions includes/SUIPlat_DigiUSB.h

This file was deleted.

11 changes: 11 additions & 0 deletions library.properties
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
name=SerialUI
version=1.14.0
author=Pat Deegan
maintainer=Pat Deegan <arduino-lib@flyingcarsandstuff.com>
sentence=A user interface through the serial channel (menus, sub-menus and command execution), with support for navigation through the menu hierarchy and online help.
paragraph=With SerialUI, you can create a hierarchy of menus and submenus of arbitrary depth (limited only by ROM/RAM space). Each menu contains a list of menu items, which are either sub-menus (lead you to another level of menu items) or commands (actually perform some type of action). Exactly what happens when a user issues a command is determined by your callbacks.
category=Communication
url=http://flyingcarsandstuff.com/projects/SerialUI/
architectures=*


7 changes: 6 additions & 1 deletion SUIMenu.cpp → src/SUIMenu.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -946,9 +946,14 @@ void Menu::showName() { sui_driver->print_P(menu_name); }

void Menu::pingRespond() {
#ifdef SUI_ENABLE_STATE_TRACKER
sui_driver->showTrackedState();
if (sui_driver->showTrackedState())
{
return;
}
#endif

sui_driver->println(' ');




Expand Down
21 changes: 21 additions & 0 deletions src/SUIPlat_ArduinoSerial.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
/*
* SUIPlat_Arduino.cpp
*
* Created on: 2013-12-13
* Author: malcalypse
*/


#include "includes/SUIPlatform.h"

#ifdef SUI_PLATFORM_ARDUINOSTANDARD
#include "includes/platform/ArduinoSerial.h"

// SUI is the namespace in which we keep all our goodies.
namespace SUI {




} /* namespace SUI */
#endif /* SUI_PLATFORM_ARDUINOSTANDARD */
2 changes: 1 addition & 1 deletion SUIPlat_DigiUSB.cpp → src/SUIPlat_DigiUSB.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
#ifdef SUI_PLATFORM_DIGISPARKUSB
// only include this stuff if we're actually using this platform...

#include "includes/SUIPlat_DigiUSB.h"
#include "includes/platform/DigiUSB.h"

namespace SUI {
int StreamImplementation::peeked = -1;
Expand Down
File renamed without changes.
41 changes: 41 additions & 0 deletions src/SUIStreamDigi.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
/*
* SUIStreamDigi.cpp
*
* Created on: Jan 7, 2016
* Author: Pat Deegan
* Part of the SerialUI Project
* Copyright (C) 2015 Pat Deegan, http://psychogenic.com
*/

#include "includes/SUIStream.h"

#ifdef SUI_PLATFORM_DIGISPARKUSB

namespace SUI {



/*
* class SUIStream -- a streaming class based on Arduino Stream.
*
* In this case, we need to augment the default stream with some
* additional methods.
*
* For the moment, these are left as non-functional stubs.
*/

// size_t readBytesUntil( char terminator, char *buffer, size_t length) { return 0;}
long SUIStream::parseInt(char skipChar=1) { return -1; }


unsigned long SUIStream::timeout() { return timeout_ms; }
void SUIStream::setTimeout(unsigned long timeout) { timeout_ms = timeout ; }

size_t SUIStream::write(uint8_t i) { return DigiUSB.write(i); }



} /* namespace SUI */

#endif /* SUI_PLATFORM_DIGISPARKUSB */

Loading

0 comments on commit dd9f508

Please sign in to comment.