codematic-cli v0.1.2

Codematic CLI

Codematic is a set of tools that enables process automation by using barcodes or QR codes - or any type of code that can be entered through a scanning device.

You can define a set of processing rules through a JSON or YAML file that will execute a chain of actions based on the barcode that has been scanned.

The CLI is targeted towards simple input devices. One general application scenario was using simple and cheap computing devices (e.g. a Raspberry Pi) in order to scan codes (e.g. an order code) and execute simple commands, such as a status update in the company's ERP system or printing a delivery note for a parcel, etc.

The configuration is really simple, so that you can create simple and reusable scanning apps in order to automate your processes.

Installation

Install Node.JS and install globally via NPM:

npm install -g codematic-cli

Usage

codematic <options>

Options:

Example: Constantly watch for new codes:

codematic --config config.yaml --watch

Options

Rules

As you can see in the example, it is very easy to define new rules. A rule consists of the following parameters:

• A name to describe the rule
• An input definition, which represents a regular expression that matches the expected code
• An action sequence that will be executed when the code is entered

As you can see, an action sequence is chained through then and error callbacks. You can pass on parameters and substitute variables within strings.

Also, it is very easy to define your own action using the registerAction method.

Codematic ships with a set of default actions, documented below.

Log Setting

Defines the log settings. If log.file is set, all processed codes will be written to the specified log file including the date/time.

Request Settings

In order to make it easy to work with REST services, you can easily define a base URL as well as a standard username and password.

Default Actions

beep

Emits a "noise" through the default system speaker

Parameters:

• count: Number of beeps (default: 1)
• delay: Delay between beeps

store

Stores a value in a variable

Parameters:

• var: Variable name
• value: Variable value (default is the last code that has been scanned)

output

Writes a string to the console using the log method.

Parameters:

• data: Output data

writefile

Writes a file

Parameters:

• filename: The filename
• mode: "append" or "write" (default is "write")
• data: The file data

readfile

Reads a file and stores it to the local store

Parameters:

• filename: The filename
• var: Variable name (default is FILE)

clear

Clears a single slot or - if no variable is defined - all variable slots

Parameters:

• var: Variable name

exec

Executes an external program and stores the output to a variable

Parameters:

• command: Command path
• var: Variable name

request

Performs an HTTP request

Parameters:

• url: The request URL
• route: If you have configured a global base URL in the Codematic options, you can also define a single route instead of a full URL
• method: GET, POST, PUT, DELETE (default is GET)
• var: The variable name for the response value (default is RESPONSE)

Sample Configuration

---
request:
  url: https://cloud.zeyos.com/pepe/remotecall/barcodeapi
  username: ''
  password: ''
log:
  error: log/error.log
  default: log/default.log
rules:
- name: Test Request
  input: "^X[0-9]+"
  action:
    type: request
    route: "/"
    200:
      type: beep
      count: 5
      delay: 10
      then:
        type: output
        data: Value stored %testvar%
- name: Store the barcode
  input: "^A[0-9]+"
  action:
    type: store
    var: testvar
    then:
      type: beep
      count: 5
      delay: 10
      then:
        type: output
        data: Value stored %testvar%
- name: Scan new barcode for request
  input: "^R[0-9]+"
  action:
    type: writefile
    filename: test.txt
    mode: append
    data: Hallo %testvar%
    then:
      type: output
      data: File written
- name: Check the wildcard
  input: ".*"
  action:
    type: store
    var: testvar
    then:
      type: output
      data: Value stored %testvar%
      then:
          type: request
          method: GET
          var: resp
          route: /%testvar%
          200:
            type: output
            data: Server response %resp%
          500:
            type: output
            data: Server error %resp%

Tip: Use Codematic on Raspberry Pi

One very useful application scenario for Codematic CLi is using as Raspberry Pi to build a "headless" scanning station.

This is very usefull, e.g. if you want to scan order documents in your facility to track the status, etc.

Step 1: Install latest Node JS and NPM

For Raspberry Pi Model A, B, B+ and Compute Module:

sudo curl -sL https://deb.nodesource.com/setup_6.x | sudo -E bash -
sudo apt-get update
sudo apt-get install -y nodejs
sudo apt-get install -y build-essential

Then copy the files to /usr/local:

sudo cp -R * /usr/local/

That's it! To check Node.js is properly install and you have the right version, run the command node -v.

Step 2: Install Codematic with NPM

Run the following command to install Codematic CLI:

npm install -g codematic-cli

You can now run codematic simply by typing codematic

Step 3: Create a config file

Create a config file in /etc/codematic.yml with your rule set, such as the example file above.

Step 4: Start Codematic on Bootup

In order to have a command or program run when the Pi boots, you can add commands to the .bashrc file.

On your Pi, edit the file /home/pi/.bashrc using the editor of your choice. You must edit with root, for example:

nano ~/.bashrc

Now add Codematic to the end of the file then save the file and exit:

# .bashrc

...

codematic --config /etc/codematic.yaml --watch