lignite 0.3.0 → 0.4.0

data/lib/lignite.rb

@@ -15,6 +15,7 @@ require "lignite/op_compiler"
 require "lignite/rbf_object"
 require "lignite/system_commands"
 require "lignite/variables"
+require "lignite/version"
 
 module Lignite
   PORT_A = 1
@@ -35,6 +36,7 @@ module Lignite
     # empty class, just for documentation purposes
   end
 
+  # Represents an error returned by the robot
   class VMError < RuntimeError
   end
 end

data/lib/lignite/assembler.rb

@@ -61,7 +61,7 @@ module Lignite
       # FIXME: id is not written?!
       logger.debug "VMTHREAD #{id}"
       logger.debug "  size #{bodyc.bytes.bytesize}"
-      logger.debug "  " + hexdump(bodyc.bytes)
+      logger.debug "  " + bin_to_hex(bodyc.bytes)
       @objects << RbfObject.vmthread(body: bodyc.bytes, local_bytes: @locals.bytesize)
     end
   end

data/lib/lignite/bytes.rb

@@ -33,8 +33,16 @@ module Lignite
       s.unpack("e").first
     end
 
-    def hexdump(s)
-      s.unpack("H*").first
+    # @param hex [String] "413432"
+    # @return [ByteString] "A42"
+    def hex_to_bin(hex)
+      [hex].pack("H*")
+    end
+
+    # @param bin [ByteString] "A42"
+    # @return [String] "413432"
+    def bin_to_hex(bin)
+      bin.unpack("H*").first
     end
   end
 end

data/lib/lignite/connection.rb

@@ -1,4 +1,7 @@
 module Lignite
+  # The communication channel to the robot.
+  # The callers use {#send} and {#receive}.
+  # Subclasses implement {#read}, {#write} and {#close}.
   class Connection
     include Bytes
     include Logger
@@ -25,6 +28,16 @@ module Lignite
       @buf = ""
     end
 
+    # @!group Subclasses must implement
+
+    # @!method read(maxlen)
+    #   @param maxlen [Integer]
+
+    # @!method write(data)
+    #   @param data [ByteString]
+
+    # @!endgroup
+
     def close
       Connection.reset
     end
@@ -52,11 +65,6 @@ module Lignite
       res
     end
 
-    # @!group Subclasses must implement
-    # @!method read(maxlen)
-    # @!method write(data)
-    # @!method close
-
     private
 
     # read must not be called with a too low value :-/

data/lib/lignite/connection/bluetooth.rb

@@ -2,6 +2,7 @@ require "socket"
 
 module Lignite
   class Connection
+    # A {Connection} over Bluetooth
     class Bluetooth < Connection
       AF_BLUETOOTH = 31
       BTPROTO_RFCOMM = 3

data/lib/lignite/connection/replay.rb

@@ -2,12 +2,15 @@ require "yaml"
 
 module Lignite
   class Connection
+    # Errors that may happen when using a {Replay} connection.
     class ReplayError < RuntimeError
     end
 
     # Replays a recorded communication.
     # It checks that #send matches the stored sends, replays the #receive.
     class Replay < Connection
+      include Bytes
+
       def initialize(filename)
         @filename = filename
 
@@ -24,11 +27,14 @@ module Lignite
       # @param payload [ByteString]
       def send(payload)
         recorded = @stream.shift
-        raise ReplayError, "Nothing left in the recording" if recorded.nil?
+        raise ReplayError, "Nothing left in the recording (#{@filename})" if recorded.nil?
         hex = recorded["SEND"]
         raise ReplayError, "Called SEND but the recording says RECV" if hex.nil?
         data = hex_to_bin(hex)
-        raise ReplayError, "Called SEND but the recorded data does not match" if data != payload
+        return if data == payload
+
+        details = "actual: #{bin_to_hex(payload)}, recorded: #{hex}"
+        raise ReplayError, "Called SEND but the recorded data does not match: #{details}"
       end
 
       # @return [ByteString] a complete message
@@ -44,14 +50,6 @@ module Lignite
         super
         raise ReplayError, "Called close but the recording has leftover data" unless @stream.empty?
       end
-
-      private
-
-      # @param hex [String] "413432"
-      # @return [ByteString] "A42"
-      def hex_to_bin(hex)
-        [hex].pack("H*")
-      end
     end
   end
 end

data/lib/lignite/connection/tap.rb

@@ -5,6 +5,8 @@ module Lignite
     # An adapter that delegates to another connection
     # and records the communication
     class Tap < Connection
+      include Bytes
+
       def initialize(conn, filename)
         raise "File #{filename} exists, will not overwrite" if File.exist?(filename)
         @conn = conn
@@ -32,14 +34,6 @@ module Lignite
         super
         @conn.close
       end
-
-      private
-
-      # @param bin [ByteString] "A42"
-      # @return [String] "413432"
-      def bin_to_hex(bin)
-        bin.unpack("H*").first
-      end
     end
   end
 end

data/lib/lignite/connection/usb.rb

@@ -2,10 +2,12 @@
 require "libusb"
 
 module Lignite
+  # No robot USB device was found
   class NoUsbDevice < RuntimeError
   end
 
   class Connection
+    # A {Connection} over a USB cable
     class Usb < Connection
       include Logger
 

data/lib/lignite/defines.rb

@@ -0,0 +1,244 @@
+# This file is generated from its .erb template. DO NOT EDIT.
+
+module Lignite
+  # Number of output ports in the system
+  OUTPUTS = 4
+
+  # Number of input  ports in the system
+  INPUTS = 4
+
+  # Number of buttons in the system
+  BUTTONS = 6
+
+  # Number of LEDs in the system
+  LEDS = 4
+
+  # LCD horizontal pixels
+  LCD_WIDTH = 178
+
+  # LCD vertical pixels
+  LCD_HEIGHT = 128
+
+  # Top line vertical pixels
+  TOPLINE_HEIGHT = 10
+
+  # Store levels
+  LCD_STORE_LEVELS = 3
+
+  DEFAULT_VOLUME = 100
+
+  DEFAULT_SLEEPMINUTES = 30
+
+  # Forground color
+  FG_COLOR = 1
+
+  # Background color
+  BG_COLOR = 0
+
+  # Number of bricks in the USB daisy chain (master + slaves)
+  CHAIN_DEPT = 4
+
+  # Max path size excluding trailing forward slash including zero termination
+  PATHSIZE = 84
+
+  # Max name size including zero termination (must be divideable by 4)
+  NAMESIZE = 32
+
+  # Max extension size including dot and zero termination
+  EXTSIZE = 5
+
+  # Max filename size including path, name, extension and termination (must be divideable by 4)
+  FILENAMESIZE = 120
+
+  # Max WIFI MAC size including zero termination
+  MACSIZE = 18
+
+  # Max WIFI IP size including zero termination
+  IPSIZE = 16
+
+  # Max bluetooth address size including zero termination
+  BTADRSIZE = 13
+
+  # Inclusive zero termination
+  ERR_STRING_SIZE = 32
+
+  EVENT_NONE = 0
+
+  EVENT_BT_PIN = 1
+
+  EVENT_BT_REQ_CONF = 2
+
+  # Highest valid device type
+  MAX_VALID_TYPE = 101
+
+  # Folder for non volatile user programs/data
+  MEMORY_FOLDER = "/mnt/ramdisk".freeze
+
+  # Folder for On Brick Programming programs
+  PROGRAM_FOLDER = "../prjs/BrkProg_SAVE".freeze
+
+  # Folder for On Brick Data log files
+  DATALOG_FOLDER = "../prjs/BrkDL_SAVE".freeze
+
+  # Folder for SD card mount
+  SDCARD_FOLDER = "../prjs/SD_Card".freeze
+
+  # Folder for USB stick mount
+  USBSTICK_FOLDER = "../prjs/USB_Stick".freeze
+
+  # Project folder
+  PRJS_DIR = "../prjs".freeze
+
+  # Apps folder
+  APPS_DIR = "../apps".freeze
+
+  # Tools folder
+  TOOLS_DIR = "../tools".freeze
+
+  # Temporary folder
+  TMP_DIR = "../tmp".freeze
+
+  # Folder for non volatile settings
+  SETTINGS_DIR = "../sys/settings".freeze
+
+  # Max directory items allocated including "." and ".."
+  DIR_DEEPT = 127
+
+  # Last run filename
+  LASTRUN_FILE_NAME = "lastrun".freeze
+
+  # Calibration data filename
+  CALDATA_FILE_NAME = "caldata".freeze
+
+  # File used in "Sleep" app to save status
+  SLEEP_FILE_NAME = "Sleep".freeze
+
+  # File used in "Volume" app to save status
+  VOLUME_FILE_NAME = "Volume".freeze
+
+  # File used in "WiFi" app to save status
+  WIFI_FILE_NAME = "WiFi".freeze
+
+  # File used in "Bluetooth" app to save status
+  BLUETOOTH_FILE_NAME = "Bluetooth".freeze
+
+  # Robot Sound File
+  EXT_SOUND = ".rsf".freeze
+
+  # Robot Graphics File
+  EXT_GRAPHICS = ".rgf".freeze
+
+  # Robot Byte code File
+  EXT_BYTECODE = ".rbf".freeze
+
+  # Robot Text File
+  EXT_TEXT = ".rtf".freeze
+
+  # Robot Datalog File
+  EXT_DATALOG = ".rdf".freeze
+
+  # Robot Program File
+  EXT_PROGRAM = ".rpf".freeze
+
+  # Robot Configuration File
+  EXT_CONFIG = ".rcf".freeze
+
+  # Robot Archive File
+  EXT_ARCHIVE = ".raf".freeze
+
+  # Brick name maximal size (including zero termination)
+  BRICKNAMESIZE = 120
+
+  # Bluetooth pass key size (including zero termination)
+  BTPASSKEYSIZE = 7
+
+  # WiFi pass key size (including zero termination)
+  WIFIPASSKEYSIZE = 33
+
+  # Character set allowed in brick name and raw filenames
+  CHARSET_NAME = 1
+
+  # Character set allowed in file names
+  CHARSET_FILENAME = 2
+
+  # Character set allowed in bluetooth pass key
+  CHARSET_BTPASSKEY = 4
+
+  # Character set allowed in WiFi pass key
+  CHARSET_WIFIPASSKEY = 8
+
+  # Character set allowed in WiFi ssid
+  CHARSET_WIFISSID = 16
+
+  # DATA8  negative limit
+  DATA8_MIN = -127
+
+  # DATA8  positive limit
+  DATA8_MAX = 127
+
+  # DATA16 negative limit
+  DATA16_MIN = -32767
+
+  # DATA16 positive limit
+  DATA16_MAX = 32767
+
+  # DATA32 negative limit
+  DATA32_MIN = -2147483647
+
+  # DATA32 positive limit
+  DATA32_MAX = 2147483647
+
+  # DATAF  negative limit
+  DATAF_MIN = -2147483647
+
+  # DATAF  positive limit
+  DATAF_MAX = 2147483647
+
+  DATA8_NAN = 128
+
+  DATA16_NAN = 32768
+
+  DATA32_NAN = 2147483648
+
+  DATAF_NAN = 2143289344
+
+  PULSE_GUI_BACKGROUND = 1
+
+  PULSE_BROWSER = 2
+
+  PULSE_KEY = 4
+
+  POP3_ABS_X = 16
+
+  POP3_ABS_Y = 50
+
+  POP3_ABS_WARN_ICON_X = 64
+
+  POP3_ABS_WARN_ICON_X1 = 40
+
+  POP3_ABS_WARN_ICON_X2 = 72
+
+  POP3_ABS_WARN_ICON_X3 = 104
+
+  POP3_ABS_WARN_ICON_Y = 60
+
+  POP3_ABS_WARN_SPEC_ICON_X = 88
+
+  POP3_ABS_WARN_SPEC_ICON_Y = 60
+
+  POP3_ABS_WARN_TEXT_X = 80
+
+  POP3_ABS_WARN_TEXT_Y = 68
+
+  POP3_ABS_WARN_YES_X = 72
+
+  POP3_ABS_WARN_YES_Y = 90
+
+  POP3_ABS_WARN_LINE_X = 21
+
+  POP3_ABS_WARN_LINE_Y = 89
+
+  POP3_ABS_WARN_LINE_ENDX = 155
+
+  # .
+end

data/lib/lignite/defines.rb.erb

@@ -0,0 +1,14 @@
+<%# This ERB template uses Ruby to generate Ruby. -%>
+module Lignite
+<% yml["defines"].each do |dname, ddata| -%>
+<%   desc = ddata["desc"] -%>
+<%   if desc -%>
+  # <%= desc %>
+<%   end -%>
+<%   dvalue = ddata["value"].inspect -%>
+<%   dvalue += ".freeze" if dvalue[0] == '"' -%>
+  <%= dname %> = <%= dvalue %>
+
+<% end -%>
+  # .
+end

data/lib/lignite/direct_commands.rb

@@ -1,4 +1,5 @@
 module Lignite
+  # This enables sending commands without wrapping them in a .rbf program
   class DirectCommands
     include Bytes
 

data/lib/lignite/enums.rb

@@ -0,0 +1,659 @@
+# This file is generated from its .erb template. DO NOT EDIT.
+
+module Lignite
+  # enum: TYPE
+  # Type values for byte codes
+
+  # Mode value that won't change mode in byte codes (convenient place to define)
+  MODE_KEEP = -1
+
+  # Type value that won't change type in byte codes
+  TYPE_KEEP = 0
+
+  # Device is NXT touch sensor
+  TYPE_NXT_TOUCH = 1
+
+  # Device is NXT light sensor
+  TYPE_NXT_LIGHT = 2
+
+  # Device is NXT sound sensor
+  TYPE_NXT_SOUND = 3
+
+  # Device is NXT color sensor
+  TYPE_NXT_COLOR = 4
+
+  # Device is NXT ultra sonic sensor
+  TYPE_NXT_ULTRASONIC = 5
+
+  # Device is NXT temperature sensor
+  TYPE_NXT_TEMPERATURE = 6
+
+  # Device is EV3/NXT tacho motor
+  TYPE_TACHO = 7
+
+  # Device is EV3 mini tacho motor
+  TYPE_MINITACHO = 8
+
+  # Device is EV3 new tacho motor
+  TYPE_NEWTACHO = 9
+
+  # Device is EV3 touch sensor
+  TYPE_TOUCH = 16
+
+  # Device is EV3 color sensor
+  TYPE_COLOR = 29
+
+  # Device is EV3 ultra sonic sensor
+  TYPE_ULTRASONIC = 30
+
+  # Device is EV3 gyro sensor
+  TYPE_GYRO = 32
+
+  # Device is EV3 IR sensor
+  TYPE_IR = 33
+
+  TYPE_THIRD_PARTY_START = 50
+
+  TYPE_THIRD_PARTY_END = 98
+
+  # Device is energy meter
+  TYPE_ENERGYMETER = 99
+
+  # Device type is not known yet
+  TYPE_IIC_UNKNOWN = 100
+
+  # Device is a NXT ADC test sensor
+  TYPE_NXT_TEST = 101
+
+  # Device is NXT IIC sensor
+  TYPE_NXT_IIC = 123
+
+  # Port is connected to a terminal
+  TYPE_TERMINAL = 124
+
+  # Port not empty but type has not been determined
+  TYPE_UNKNOWN = 125
+
+  # Port empty or not available
+  TYPE_NONE = 126
+
+  # Port not empty and type is invalid
+  TYPE_ERROR = 127
+
+  # enum: SLOT
+  # Program ID's (Slots)
+
+  # Program slot reserved for executing the user interface
+  GUI_SLOT = 0
+
+  # Program slot used to execute user projects, apps and tools
+  USER_SLOT = 1
+
+  # Program slot used for direct commands coming from c_com
+  CMD_SLOT = 2
+
+  # Program slot used for direct commands coming from c_ui
+  TERM_SLOT = 3
+
+  # Program slot used to run the debug ui
+  DEBUG_SLOT = 4
+
+  # Maximum slots supported by the VM
+  SLOTS = 5
+
+  CURRENT_SLOT = -1
+
+  # enum: BUTTONTYPE
+  # Button
+
+  NO_BUTTON = 0
+
+  UP_BUTTON = 1
+
+  ENTER_BUTTON = 2
+
+  DOWN_BUTTON = 3
+
+  RIGHT_BUTTON = 4
+
+  LEFT_BUTTON = 5
+
+  BACK_BUTTON = 6
+
+  ANY_BUTTON = 7
+
+  BUTTONTYPES = 8
+
+  # enum: BROWSERTYPE
+  # Browser Types Avaliable
+
+  # Browser for folders
+  BROWSE_FOLDERS = 0
+
+  # Browser for folders and files
+  BROWSE_FOLDS_FILES = 1
+
+  # Browser for cached / recent files
+  BROWSE_CACHE = 2
+
+  # Browser for files
+  BROWSE_FILES = 3
+
+  # Maximum browser types supported by the VM
+  BROWSERTYPES = 4
+
+  # enum: FONTTYPE
+  # Font Types Avaliable
+
+  NORMAL_FONT = 0
+
+  SMALL_FONT = 1
+
+  LARGE_FONT = 2
+
+  TINY_FONT = 3
+
+  # Maximum font types supported by the VM
+  FONTTYPES = 4
+
+  # enum: ICONTYPE
+  # Icon Types Avaliable
+
+  # 24x12_Files_Folders_Settings.bmp
+  NORMAL_ICON = 0
+
+  SMALL_ICON = 1
+
+  # 24x22_Yes_No_OFF_FILEOps.bmp
+  LARGE_ICON = 2
+
+  MENU_ICON = 3
+
+  # 8x12_miniArrows.bmp
+  ARROW_ICON = 4
+
+  # Maximum icon types supported by the VM
+  ICONTYPES = 5
+
+  # enum: S_ICON_NO
+
+  SICON_CHARGING = 0
+
+  SICON_BATT_4 = 1
+
+  SICON_BATT_3 = 2
+
+  SICON_BATT_2 = 3
+
+  SICON_BATT_1 = 4
+
+  SICON_BATT_0 = 5
+
+  SICON_WAIT1 = 6
+
+  SICON_WAIT2 = 7
+
+  SICON_BT_ON = 8
+
+  SICON_BT_VISIBLE = 9
+
+  SICON_BT_CONNECTED = 10
+
+  SICON_BT_CONNVISIB = 11
+
+  SICON_WIFI_3 = 12
+
+  SICON_WIFI_2 = 13
+
+  SICON_WIFI_1 = 14
+
+  SICON_WIFI_CONNECTED = 15
+
+  SICON_USB = 21
+
+  S_ICON_NOS = 22
+
+  # enum: N_ICON_NO
+
+  ICON_NONE = -1
+
+  ICON_RUN = 0
+
+  ICON_FOLDER = 1
+
+  ICON_FOLDER2 = 2
+
+  ICON_USB = 3
+
+  ICON_SD = 4
+
+  ICON_SOUND = 5
+
+  ICON_IMAGE = 6
+
+  ICON_SETTINGS = 7
+
+  ICON_ONOFF = 8
+
+  ICON_SEARCH = 9
+
+  ICON_WIFI = 10
+
+  ICON_CONNECTIONS = 11
+
+  ICON_ADD_HIDDEN = 12
+
+  ICON_TRASHBIN = 13
+
+  ICON_VISIBILITY = 14
+
+  ICON_KEY = 15
+
+  ICON_CONNECT = 16
+
+  ICON_DISCONNECT = 17
+
+  ICON_UP = 18
+
+  ICON_DOWN = 19
+
+  ICON_WAIT1 = 20
+
+  ICON_WAIT2 = 21
+
+  ICON_BLUETOOTH = 22
+
+  ICON_INFO = 23
+
+  ICON_TEXT = 24
+
+  ICON_QUESTIONMARK = 27
+
+  ICON_INFO_FILE = 28
+
+  ICON_DISC = 29
+
+  ICON_CONNECTED = 30
+
+  ICON_OBP = 31
+
+  ICON_OBD = 32
+
+  ICON_OPENFOLDER = 33
+
+  ICON_BRICK1 = 34
+
+  N_ICON_NOS = 35
+
+  # enum: L_ICON_NO
+
+  YES_NOTSEL = 0
+
+  YES_SEL = 1
+
+  NO_NOTSEL = 2
+
+  NO_SEL = 3
+
+  OFF = 4
+
+  WAIT_VERT = 5
+
+  WAIT_HORZ = 6
+
+  TO_MANUAL = 7
+
+  WARNSIGN = 8
+
+  WARN_BATT = 9
+
+  WARN_POWER = 10
+
+  WARN_TEMP = 11
+
+  NO_USBSTICK = 12
+
+  TO_EXECUTE = 13
+
+  TO_BRICK = 14
+
+  TO_SDCARD = 15
+
+  TO_USBSTICK = 16
+
+  TO_BLUETOOTH = 17
+
+  TO_WIFI = 18
+
+  TO_TRASH = 19
+
+  TO_COPY = 20
+
+  TO_FILE = 21
+
+  CHAR_ERROR = 22
+
+  COPY_ERROR = 23
+
+  PROGRAM_ERROR = 24
+
+  WARN_MEMORY = 27
+
+  L_ICON_NOS = 28
+
+  # enum: M_ICON_NO
+
+  ICON_STAR = 0
+
+  ICON_LOCKSTAR = 1
+
+  ICON_LOCK = 2
+
+  # Bluetooth type PC
+  ICON_PC = 3
+
+  # Bluetooth type PHONE
+  ICON_PHONE = 4
+
+  # Bluetooth type BRICK
+  ICON_BRICK = 5
+
+  # Bluetooth type UNKNOWN
+  ICON_UNKNOWN = 6
+
+  ICON_FROM_FOLDER = 7
+
+  ICON_CHECKBOX = 8
+
+  ICON_CHECKED = 9
+
+  ICON_XED = 10
+
+  M_ICON_NOS = 11
+
+  # enum: A_ICON_NO
+
+  ICON_LEFT = 1
+
+  ICON_RIGHT = 2
+
+  A_ICON_NOS = 3
+
+  # enum: BTTYPE
+  # Bluetooth Device Types
+
+  # Bluetooth type PC
+  BTTYPE_PC = 3
+
+  # Bluetooth type PHONE
+  BTTYPE_PHONE = 4
+
+  # Bluetooth type BRICK
+  BTTYPE_BRICK = 5
+
+  # Bluetooth type UNKNOWN
+  BTTYPE_UNKNOWN = 6
+
+  BTTYPES = 7
+
+  # enum: LEDPATTERN
+  # LED Pattern
+
+  LED_BLACK = 0
+
+  LED_GREEN = 1
+
+  LED_RED = 2
+
+  LED_ORANGE = 3
+
+  LED_GREEN_FLASH = 4
+
+  LED_RED_FLASH = 5
+
+  LED_ORANGE_FLASH = 6
+
+  LED_GREEN_PULSE = 7
+
+  LED_RED_PULSE = 8
+
+  LED_ORANGE_PULSE = 9
+
+  LEDPATTERNS = 10
+
+  # enum: LEDTYPE
+
+  # All LEDs
+  LED_ALL = 0
+
+  # Right red
+  LED_RR = 1
+
+  # Right green
+  LED_RG = 2
+
+  # Left red
+  LED_LR = 3
+
+  # Left green
+  LED_LG = 4
+
+  # enum: FILETYPE
+  # File Types Avaliable
+
+  FILETYPE_UNKNOWN = 0
+
+  TYPE_FOLDER = 1
+
+  TYPE_SOUND = 2
+
+  TYPE_BYTECODE = 3
+
+  TYPE_GRAPHICS = 4
+
+  TYPE_DATALOG = 5
+
+  TYPE_PROGRAM = 6
+
+  TYPE_TEXT = 7
+
+  TYPE_SDCARD = 16
+
+  TYPE_USBSTICK = 32
+
+  FILETYPES = 33
+
+  TYPE_RESTART_BROWSER = -1
+
+  TYPE_REFRESH_BROWSER = -2
+
+  # enum: RESULT
+  # Describes result from executing functions
+
+  # No errors to report
+  OK = 0
+
+  # Busy - try again
+  BUSY = 1
+
+  # Something failed
+  FAIL = 2
+
+  # Stopped
+  STOP = 4
+
+  # Start
+  START = 8
+
+  # enum: DATA_FORMAT
+  # Data formats used in device type formats
+
+  # DATA8
+  DATA_8 = 0
+
+  # DATA16
+  DATA_16 = 1
+
+  # DATA32
+  DATA_32 = 2
+
+  # DATAF
+  DATA_F = 3
+
+  # Zero terminated string
+  DATA_S = 4
+
+  # Array handle
+  DATA_A = 5
+
+  # Variable type
+  DATA_V = 7
+
+  # Percent
+  DATA_PCT = 16
+
+  # Raw
+  DATA_RAW = 18
+
+  # SI unit
+  DATA_SI = 19
+
+  DATA_FORMATS = 20
+
+  # enum: DEL
+  # Delimiter codes used to define how data is separated in files
+
+  # No delimiter at all
+  DEL_NONE = 0
+
+  # Use tab as delimiter
+  DEL_TAB = 1
+
+  # Use space as delimiter
+  DEL_SPACE = 2
+
+  # Use return as delimiter
+  DEL_RETURN = 3
+
+  # Use colon as delimiter
+  DEL_COLON = 4
+
+  # Use comma as delimiter
+  DEL_COMMA = 5
+
+  # Use line feed as delimiter
+  DEL_LINEFEED = 6
+
+  # Use return+line feed as delimiter
+  DEL_CRLF = 7
+
+  DELS = 8
+
+  # enum: HWTYPE
+  # Hardware Transport Layer
+
+  HW_USB = 1
+
+  HW_BT = 2
+
+  HW_WIFI = 3
+
+  HWTYPES = 4
+
+  # enum: ENCRYPT
+  # Encryption Types
+
+  ENCRYPT_NONE = 0
+
+  ENCRYPT_WPA2 = 1
+
+  ENCRYPTS = 2
+
+  # enum: LMS_ENCRYPT
+  # Encryption Types
+
+  LMS_ENCRYPT_NONE = 0
+
+  LMS_ENCRYPT_WPA2 = 1
+
+  LMS_ENCRYPTS = 2
+
+  # enum: COLOR
+
+  RED = 0
+
+  GREEN = 1
+
+  BLUE = 2
+
+  BLANK = 3
+
+  COLORS = 4
+
+  # enum: NXTCOLOR
+  # Constants related to color sensor value using Color sensor as color detector
+
+  BLACKCOLOR = 1
+
+  BLUECOLOR = 2
+
+  GREENCOLOR = 3
+
+  YELLOWCOLOR = 4
+
+  REDCOLOR = 5
+
+  WHITECOLOR = 6
+
+  # enum: WARNING
+  # Warnings
+
+  WARNING_TEMP = 1
+
+  WARNING_CURRENT = 2
+
+  WARNING_VOLTAGE = 4
+
+  WARNING_MEMORY = 8
+
+  WARNING_DSPSTAT = 16
+
+  WARNING_RAM = 32
+
+  WARNING_BATTLOW = 64
+
+  WARNING_BUSY = 128
+
+  WARNINGS = 63
+
+  # enum: OBJSTAT
+  # Values used to describe an object's status
+
+  # Object code is running
+  RUNNING = 16
+
+  # Object is waiting for final trigger
+  WAITING = 32
+
+  # Object is stopped or not triggered yet
+  STOPPED = 64
+
+  # Object is halted because a call is in progress
+  HALTED = 128
+
+  # enum: DEVCMD
+  # Device commands used to control (UART sensors) devices
+
+  # UART device reset
+  DEVCMD_RESET = 17
+
+  # UART device fire   (ultrasonic)
+  DEVCMD_FIRE = 17
+
+  # UART device channel (IR seeker)
+  DEVCMD_CHANNEL = 18
+
+  DEVCMDS = 19
+
+  # .
+end