farmbot

v6.0.0

farmbot

farmbot v6.0.0 Farmbot.CeleryScript.Types View Source

Common types for shared CeleryScript Nodes.

Link to this section Summary

Types

ast()
axis()

X | Y | Z

coord_ast()

Ast in the shaps of:

%Ast{
  kind: "coordinate",
  args: %{x: int, y: int, z: int},
  body: []
}
coord_x()

Integer representing an X coord

coord_x_bin()

The literal string X

coord_y()

Integer representing an Y coord

coord_y_bin()

The literal string Y

coord_z()

Integer representing an X coord

coord_z_bin()

The literal string Z

expl_ast_args()

Ast in the shape of:

%Ast{
  kind: "explanation",
  args: %{message: binary},
  body: []
}
explanation_ast()
nothing_ast()

Ast in the shape of:

%Ast{
  kind: "nothing",
  args: %{},
  body: []
}
package()

usually either farmbot_os | arduino_firmware but will also be things like

pair_ast()

Ast in the shape of:

%Ast{
  kind: "pair",
  args: %{label: binary, value: any},
  body: []
}
pairs_ast()
pin_mode()

Integer representing digital (0) or pwm (1)

pin_number()

Integer representing a pin on the arduino

Link to this section Types

Link to this type coord_ast() View Source 
coord_ast() :: %Farmbot.CeleryScript.Ast{args: coord_args, body: [], comment: term, kind: binary}

Ast in the shaps of:

%Ast{
  kind: "coordinate",
  args: %{x: int, y: int, z: int},
  body: []
}
Link to this type coord_x() View Source 
coord_x() :: integer

Integer representing an X coord.

Link to this type coord_x_bin() View Source 
coord_x_bin() :: binary

The literal string X

Link to this type coord_y() View Source 
coord_y() :: integer

Integer representing an Y coord.

Link to this type coord_y_bin() View Source 
coord_y_bin() :: binary

The literal string Y

Link to this type coord_z() View Source 
coord_z() :: integer

Integer representing an X coord.

Link to this type coord_z_bin() View Source 
coord_z_bin() :: binary

The literal string Z

Link to this type expl_ast_args() View Source 
expl_ast_args() :: %{message: binary}

Ast in the shape of:

%Ast{
  kind: "explanation",
  args: %{message: binary},
  body: []
}
Link to this type explanation_ast() View Source 
explanation_ast() :: %Farmbot.CeleryScript.Ast{args: expl_ast_args, body: [], comment: term, kind: binary}
Link to this type nothing_ast() View Source 
nothing_ast() :: %Farmbot.CeleryScript.Ast{args: %{}, body: [], comment: term, kind: binary}

Ast in the shape of:

%Ast{
  kind: "nothing",
  args: %{},
  body: []
}
Link to this type package() View Source 
package() :: binary

usually either farmbot_os | arduino_firmware but will also be things like:

  • Farmware Names
  • Sync resources.
Link to this type pair_ast() View Source 
pair_ast() :: ast

Ast in the shape of:

%Ast{
  kind: "pair",
  args: %{label: binary, value: any},
  body: []
}
Link to this type pairs_ast() View Source 
pairs_ast() :: [pair_ast]
Link to this type pin_mode() View Source 
pin_mode() :: 0 | 1

Integer representing digital (0) or pwm (1)

Link to this type pin_number() View Source 
pin_number() :: 0..69

Integer representing a pin on the arduino.