Pseduo-YAML

Logic defined in YAML

Pseduo-YAML is a set of operations that are defined in a Cyanobyte specification. It is not entirely a programming language, but lets one define what is effectively pseduocode in a YAML format. In writing these operations you define essentially an abstract syntax tree that can be parsed into specific programming languages for a particular device platform.

The features available in Pseduo-YAML are meant to be broadly available across languages, and should work in ways that respect a variety of platform features like threads and callbacks.

The available operations and parameters are defined in JSON schema.

Commands

All commands are prefixed by a dollar sign rather than a variable name.

Write Operation

This will write a specific value or variable to a specified register.

- $cmdWrite:
    register: '#/registers/myRegisterName'
    value: variableName

Operations

Common Arithmetic

These common arithmetic operations can accept variables, numbers, or nested operations of any size.

  • sum
  • difference
  • product

  • division

    - variableName:
- sum:
    - previousVariable
    - product:
        - otherVariable
        - 5

Advanced Arithemtic

These more advanced arithmetic operations accept 2 elements, which may be variables, numbers, or nested operations.

  • power

  • modulus

    - variableName:
- power:
    - previousVariable
    - sum:
        - otherVariable
        - 5

Bitwise Operations

These bitwise operations can accept variables, numbers, or nested operations of any size.

  • bitwiseOr

  • bitwiseAnd

    - variableName:
- bitwiseOr:
    - previousVariable
    - bitwiseAnd:
        - otherVariable
        - 0b11

Bit Shifting

These bit shift operations require two properties. The var field requires a variable name. The bits field requires an integer number of bits to shift.

  • bitShiftLeft

  • bitShiftRight

    - variableName:
- bitShiftLeft:
    var: variableName
    bits: 2

Trigonometry

These operations only accept the string variable name or number for which the operations should be computed. These are computed in radians.

  • arc tangent

    - variableName:
- arc tanget: previousVariable

I/O Operations

Raw Read

This operation will directly read a number of bits from the device bus.

- variableName:
    rawRead: 16

Flow

Delays

Delays can be defined in terms of milliseconds. A delay should accept a time, a name for the delay, and an array of logical operations to happen after the delay.

The name of the delay will be used in some language templates which require a callback name as the platform doesn’t block.

Note: A delay must be the last operation in a list of logical operations. Some language templates do not know how to handle more than one delay.