User prop add hardware id

From Sim Innovations Wiki
Jump to navigation Jump to search

Description

user_prop_id = user_prop_add_hardware_id(name, default_value, description)

user_prop_add_hardware_id will add an additional user customizable setting to your instrument of the type hardware ID.

Return value

Argument Type Description
user_prop_id ID This value can be used for further reference. Functions such as user_prop_get can use this user_prop_id. Its good practice to store this persist_id in your logic code.

Arguments

# Argument Type Description
1 name String The name of the user property. This name must be unique (there may only be one user property of a certain name in an instrument)
2 default_value String The default value of the property. The is the value the property gets when the user adds the instrument to a panel.
3 description String A description of the property, explaining to the user what function this user property has.

Example

-- Let's give our instrument a property
power_button_hw_id = user_prop_add_hardware_id("Power button", "ARDUINO_MEGA2560_A_D3", "The power button hardware pin")

function button_pressed()
  print("Power button is pressed!")
end

hw_button_add(user_prop_get(power_button_hw_id), button_pressed)
Settings visible to user within instrument configuration