165 lines
8.0 KiB
Ruby
165 lines
8.0 KiB
Ruby
# All configuration related to validation of sequences. This includes
|
|
# information such as which operators and labels are allowed, custom validations
|
|
# when a sequence is saved and related error messages that result.
|
|
# This module helps unclutter sequence.rb by sweeping CeleryScript config under
|
|
# the rug. Shoving configuration into a module is not a design pattern. Feedback
|
|
# welcome for refactoring of this code.
|
|
module CeleryScriptSettingsBag
|
|
DIGITAL, ANALOG = 0, 1
|
|
ALLOWED_PIN_MODES = [DIGITAL, ANALOG]
|
|
ALLOWED_VAR_TYPES = %w(location)
|
|
ALLOWED_RPC_NODES = %w(home emergency_lock emergency_unlock read_status
|
|
sync check_updates power_off reboot toggle_pin
|
|
config_update calibrate execute move_absolute
|
|
move_relative write_pin read_pin send_message
|
|
factory_reset execute_script set_user_env wait
|
|
add_point install_farmware update_farmware
|
|
remove_farmware take_photo data_update)
|
|
ALLOWED_PACKAGES = %w(farmbot_os arduino_firmware)
|
|
ALLOWED_CHAGES = %w(add remove update)
|
|
RESOURCE_NAME = %w(images plants regimens planting_area peripherals
|
|
corpuses tool_bays logs sequences farm_events
|
|
tool_slots tools points tokens users device)
|
|
ALLOWED_MESSAGE_TYPES = %w(success busy warn error info fun)
|
|
ALLOWED_CHANNEL_NAMES = %w(ticker toast)
|
|
ALLOWED_DATA_TYPES = %w(string integer)
|
|
ALLOWED_OPS = %w(< > is not)
|
|
ALLOWED_AXIS = %w(x y z all)
|
|
STEPS = %w(move_absolute move_relative write_pin read_pin wait
|
|
send_message execute _if execute_script take_photo)
|
|
ALLOWED_LHS = %w(pin0 pin1 pin2 pin3 pin4 pin5 pin6 pin7 pin8 pin9
|
|
pin10 pin11 pin12 pin13 x y z)
|
|
BAD_ALLOWED_PIN_MODES = '"%s" is not a valid pin_mode. Allowed values: %s'
|
|
BAD_LHS = 'Can not put "%s" into a left hand side (LHS) '\
|
|
'argument. Allowed values: %s'
|
|
BAD_SUB_SEQ = 'Sequence #%s does not exist.'
|
|
NO_SUB_SEQ = 'missing a sequence selection for `execute` block.'
|
|
BAD_REGIMEN = 'Regimen #%s does not exist.'
|
|
BAD_OP = 'Can not put "%s" into an operand (OP) argument. '\
|
|
'Allowed values: %s'
|
|
BAD_CHANNEL_NAME = '"%s" is not a valid channel_name. Allowed values: %s'
|
|
BAD_MESSAGE_TYPE = '"%s" is not a valid message_type. Allowed values: %s'
|
|
BAD_TOOL_ID = 'Tool #%s does not exist.'
|
|
BAD_PACKAGE = '"%s" is not a valid package. Allowed values: %s'
|
|
BAD_AXIS = '"%s" is not a valid axis. Allowed values: %s'
|
|
BAD_VAR_TYPE = '"%s" is not a valid type. Allowed values: %s'
|
|
Corpus = CeleryScript::Corpus
|
|
.new
|
|
.defineArg(:var_type, [String]) do |node|
|
|
within(ALLOWED_VAR_TYPES, node) do |val|
|
|
BAD_VAR_TYPE % [val.to_s, ALLOWED_VAR_TYPES.inspect]
|
|
end
|
|
end
|
|
.defineArg(:pin_mode, [Fixnum]) do |node|
|
|
within(ALLOWED_PIN_MODES, node) do |val|
|
|
BAD_ALLOWED_PIN_MODES % [val.to_s, ALLOWED_PIN_MODES.inspect]
|
|
end
|
|
end
|
|
.defineArg(:sequence_id, [Fixnum]) do |node|
|
|
if (node.value == 0)
|
|
node.invalidate!(NO_SUB_SEQ)
|
|
else
|
|
missing = !Sequence.exists?(node.value)
|
|
node.invalidate!(BAD_SUB_SEQ % [node.value]) if missing
|
|
end
|
|
end
|
|
.defineArg(:lhs, [String]) do |node|
|
|
within(ALLOWED_LHS, node) do |val|
|
|
BAD_LHS % [val.to_s, ALLOWED_LHS.inspect]
|
|
end
|
|
end
|
|
.defineArg(:op, [String]) do |node|
|
|
within(ALLOWED_OPS, node) do |val|
|
|
BAD_OP % [val.to_s, ALLOWED_OPS.inspect]
|
|
end
|
|
end
|
|
.defineArg(:channel_name, [String]) do |node|
|
|
within(ALLOWED_CHANNEL_NAMES, node) do |val|
|
|
BAD_CHANNEL_NAME % [val.to_s, ALLOWED_CHANNEL_NAMES.inspect]
|
|
end
|
|
end
|
|
.defineArg(:message_type, [String]) do |node|
|
|
within(ALLOWED_MESSAGE_TYPES, node) do |val|
|
|
BAD_MESSAGE_TYPE % [val.to_s, ALLOWED_MESSAGE_TYPES.inspect]
|
|
end
|
|
end
|
|
.defineArg(:tool_id, [Fixnum]) do |node|
|
|
node.invalidate!(BAD_TOOL_ID % node.value) if !Tool.exists?(node.value)
|
|
end
|
|
.defineArg(:package, [String]) do |node|
|
|
within(ALLOWED_PACKAGES, node) do |val|
|
|
BAD_PACKAGE % [val.to_s, ALLOWED_PACKAGES.inspect]
|
|
end
|
|
end
|
|
.defineArg(:axis, [String]) do |node|
|
|
within(ALLOWED_AXIS, node) do |val|
|
|
BAD_AXIS % [val.to_s, ALLOWED_AXIS.inspect]
|
|
end
|
|
end
|
|
.defineArg(:version, [Fixnum])
|
|
.defineArg(:x, [Fixnum])
|
|
.defineArg(:y, [Fixnum])
|
|
.defineArg(:z, [Fixnum])
|
|
.defineArg(:radius, [Fixnum])
|
|
.defineArg(:speed, [Fixnum])
|
|
.defineArg(:pin_number, [Fixnum])
|
|
.defineArg(:pin_value, [Fixnum])
|
|
.defineArg(:milliseconds, [Fixnum])
|
|
.defineArg(:rhs, [Fixnum])
|
|
.defineArg(:value, [String, Fixnum, TrueClass, FalseClass])
|
|
.defineArg(:label, [String])
|
|
.defineArg(:package, [String])
|
|
.defineArg(:message, [String])
|
|
.defineArg(:location, [:tool, :coordinate])
|
|
.defineArg(:offset, [:coordinate])
|
|
.defineArg(:_then, [:execute, :nothing])
|
|
.defineArg(:_else, [:execute, :nothing])
|
|
.defineArg(:url, [String])
|
|
.defineNode(:install_farmware,[:url])
|
|
.defineNode(:update_farmware, [:package])
|
|
.defineNode(:remove_farmware, [:package])
|
|
.defineNode(:nothing, [])
|
|
.defineNode(:tool, [:tool_id])
|
|
.defineNode(:coordinate, [:x, :y, :z])
|
|
.defineNode(:move_absolute, [:location, :speed, :offset])
|
|
.defineNode(:move_relative, [:x, :y, :z, :speed])
|
|
.defineNode(:write_pin, [:pin_number, :pin_value, :pin_mode ])
|
|
.defineNode(:read_pin, [:pin_number, :label, :pin_mode])
|
|
.defineNode(:channel, [:channel_name])
|
|
.defineNode(:wait, [:milliseconds])
|
|
.defineNode(:send_message, [:message, :message_type], [:channel])
|
|
.defineNode(:execute, [:sequence_id])
|
|
.defineNode(:_if, [:lhs, :op, :rhs, :_then, :_else])
|
|
.defineNode(:sequence, [:version], STEPS)
|
|
.defineNode(:home, [:speed, :axis], [])
|
|
.defineNode(:emergency_lock, [], [])
|
|
.defineNode(:emergency_unlock, [], [])
|
|
.defineNode(:read_status, [], [])
|
|
.defineNode(:sync, [], [])
|
|
.defineNode(:check_updates, [:package], [])
|
|
.defineNode(:power_off, [], [])
|
|
.defineNode(:reboot, [], [])
|
|
.defineNode(:toggle_pin, [:pin_number], [])
|
|
.defineNode(:explanation, [:message], [])
|
|
.defineNode(:rpc_request, [:label], ALLOWED_RPC_NODES)
|
|
.defineNode(:rpc_ok, [:label], [])
|
|
.defineNode(:rpc_error, [:label], [:explanation])
|
|
.defineNode(:calibrate, [:axis], [])
|
|
.defineNode(:pair, [:label, :value], [])
|
|
.defineNode(:config_update, [:package], [:pair])
|
|
.defineNode(:factory_reset, [], [])
|
|
.defineNode(:execute_script, [:label], [:pair])
|
|
.defineNode(:set_user_env, [], [:pair])
|
|
.defineNode(:add_point, [:location], [:pair])
|
|
.defineNode(:take_photo, [], [])
|
|
.defineNode(:data_update, [:value], [:pair])
|
|
.defineNode(:variable, [:var_type, :label], [])
|
|
|
|
# Given an array of allowed values and a CeleryScript AST node, will DETERMINE
|
|
# if the node contains a legal value. Throws exception and invalidates if not.
|
|
def self.within(array, node)
|
|
val = node&.value
|
|
node.invalidate!(yield(val)) if !array.include?(val)
|
|
end
|
|
end
|