| Each alarm is only triggered once. Alarms are scanned in order from the top of the table to the bottom. |
-
| Field | -Description | -
|---|---|
| Nr | -Alarm number for reference. | -
| Status | -Activate or Deactivate the alarm. | -
| If Alarm | -Alarm triggered only if the alarm with the given number was triggered before. Use 0 for no guard. | -
| But Not | -Alarm triggered only if the alarm with the given number was not triggered before. Use 0 for no guard. | -
| From | -Alarm only triggered after the given event. | -
| Time | -If not 00:00, alarm is triggered mm:ss after the event "From" happens. | -
| Source | -The observed temperature source. | -
| Condition | -Alarm is triggered if source rises above or below the specified temperature. | -
| Temp | -The specified temperature limit. | -
| Action | -The action to be triggered if all conditions are fulfilled. | -
| Description | -Commands for alarms with an action go here. Anything after a '#' character is considered a comment and is ignored when processing the alarm. | -
| Option | -Description | -
|---|---|
| Add | -Adds a new alarm to the bottom of the table. | -
| Insert | -Inserts a new alarm above the selected alarm. | -
| Delete | -Deletes the selected alarm. | -
| Copy Table | -Copy the alarm table in tab separated format to the clipboard. Option or ALT click to copy a tabular format to the clipboard. | -
| All On | -Enables all alarms. | -
| All Off | -Disables all alarms. | -
| Load | -Load alarm definition from a file. | -
| Save | -Save the alarm definitions to a file. | -
| Clear | -Clears all alarms from the table. | -
| Help | -Opens this window. | -
| Load from Profile | -when ticked will replace the alarm table when loading a profile with the alarms stored in the profile. If there are no alarms in the profile the alarm table will be cleared. | -
| Load from Background | -when ticked will replace the alarm table when loading a background profile with the alarms stored in the profile. If there are no alarms in the profile the alarm table will be cleared. | -
| PopUp TimeOut | -A PopUp will automatically close after this time if the OK button has not been clicked. | -
| Enter the Command into the Description field of the Alarm. | -
| Action | -Command | -Meaning | -
|---|---|---|
| Pop Up | -<text> | -the text to be displayed in the pop up | -
| Call Program | -A program/script path (absolute or relative) | -start an external program | -
| Event Button | -<button number> | -triggers the button, the button number comes from the Events Buttons configuration | -
| Slider <1> | -<value> | -set the slider for special event nr. 1 to the value | -
| Slider <2> | -<value> | -set the slider for special event nr. 2 to the value | -
| Slider <3> | -<value> | -set the slider for special event nr. 3 to the value | -
| Slider <4> | -<value> | -set the slider for special event nr. 4 to the value | -
| START | -- | trigger START | -
| DRY | -- | trigger the DRY event | -
| FCs | -- | trigger the FCs event | -
| FCe | -- | trigger the FCe event | -
| SCs | -- | trigger the SCs event | -
| SCe | -- | trigger the SCe event | -
| DROP | -- | trigger the DROP event | -
| COOL END | -- | trigger the COOL END event | -
| OFF | -- | trigger OFF | -
| CHARGE | -- | trigger the CHARGE event | -
| RampSoak ON | -- | turns PID on and switches to RampSoak mode | -
| RampSoak OFF | -- | turns PID off and switches to manual mode | -
| Set Canvas Color | -<color> | -sets the canvas to <color>, can be in hex format, e.g. "#ffaa55" or a color name, e.g. "blue" | -
| Reset Canvas Color | -- | reset the canvas color to the color specified in Config>>Colors canvas color resets automatically at OFF |
-
| Each alarm is only triggered once. Alarms are scanned in order from the top of the table to the bottom. |
+
| Field | +Description | +
|---|---|
| Nr | +Alarm number for reference. | +
| Status | +Activate or Deactivate the alarm. | +
| If Alarm | +Alarm triggered only if the alarm with the given number was triggered before. Use 0 for no guard. | +
| But Not | +Alarm triggered only if the alarm with the given number was not triggered before. Use 0 for no guard. | +
| From | +Alarm only triggered after the given event. | +
| Time | +If not 00:00, alarm is triggered mm:ss after the event "From" happens. | +
| Source | +The observed temperature source. | +
| Condition | +Alarm is triggered if source rises above or below the specified temperature. | +
| Temp | +The specified temperature limit. | +
| Action | +The action to be triggered if all conditions are fulfilled. | +
| Description | +Commands for alarms with an action go here. Anything after a '#' character is considered a comment and is ignored when processing the alarm. | +
| Option | +Description | +
|---|---|
| Add | +Adds a new alarm to the bottom of the table. | +
| Insert | +Inserts a new alarm above the selected alarm. | +
| Delete | +Deletes the selected alarm. | +
| Copy Table | +Copy the alarm table in tab separated format to the clipboard. Option or ALT click to copy a tabular format to the clipboard. | +
| All On | +Enables all alarms. | +
| All Off | +Disables all alarms. | +
| Load | +Load alarm definition from a file. | +
| Save | +Save the alarm definitions to a file. | +
| Clear | +Clears all alarms from the table. | +
| Help | +Opens this window. | +
| Load from Profile | +when ticked will replace the alarm table when loading a profile with the alarms stored in the profile. If there are no alarms in the profile the alarm table will be cleared. | +
| Load from Background | +when ticked will replace the alarm table when loading a background profile with the alarms stored in the profile. If there are no alarms in the profile the alarm table will be cleared. | +
| PopUp TimeOut | +A PopUp will automatically close after this time if the OK button has not been clicked. | +
| Enter the Command into the Description field of the Alarm. | +
| Action | +Command | +Meaning | +
|---|---|---|
| Pop Up | +<text> | +the text to be displayed in the pop up | +
| Call Program | +A program/script path (absolute or relative) | +start an external program | +
| Event Button | +<button number> | +triggers the button, the button number comes from the Events Buttons configuration | +
| Slider <1> | +<value> | +set the slider for special event nr. 1 to the value | +
| Slider <2> | +<value> | +set the slider for special event nr. 2 to the value | +
| Slider <3> | +<value> | +set the slider for special event nr. 3 to the value | +
| Slider <4> | +<value> | +set the slider for special event nr. 4 to the value | +
| START | ++ | trigger START | +
| DRY | ++ | trigger the DRY event | +
| FCs | ++ | trigger the FCs event | +
| FCe | ++ | trigger the FCe event | +
| SCs | ++ | trigger the SCs event | +
| SCe | ++ | trigger the SCe event | +
| DROP | ++ | trigger the DROP event | +
| COOL END | ++ | trigger the COOL END event | +
| OFF | ++ | trigger OFF | +
| CHARGE | ++ | trigger the CHARGE event | +
| RampSoak ON | ++ | turns PID on and switches to RampSoak mode | +
| RampSoak OFF | ++ | turns PID off and switches to manual mode | +
| Set Canvas Color | +<color> | +sets the canvas to <color>, can be in hex format, e.g. "#ffaa55" or a color name, e.g. "blue" | +
| Reset Canvas Color | ++ | reset the canvas color to the color specified in Config>>Colors canvas color resets automatically at OFF |
+
| Dialog Field | -Meaning | -
|---|---|
| Autosave [a] | -Turn Autosave ON or OFF. When sampling, the keyboard 'a' will save the profile at that moment. NOTE: Files with the same file name will be silently overwritten. Use ~currdatetime in the file name prefix to get unique file names. |
-
| Add to recent file list | -When checked, Autosaved files will be added to the Files>> Open Recent files list. | -
| File Name Prefix | -Defines the file name to use for Autosave. See the Autosave Fields section below. | -
| Preview: | -Shows an example of the file name based on the File Name Prefix field. A 'While Recording:' example will also be shown if the file name will be different when the scope is sampling. |
-
| Path | -Where to store the Autosaved files. | -
| Save Also | -Allows to save an additional file. Choose the file type from the pull-down menu. | -
| Path | -Where to store the additional files. | -
| Prefix Field | -Source | -Example | -
|---|---|---|
| ~batchprefix | -The batch prefix set in Config>Batch>Prefix | -Prod- | -
| ~batchcounter | -The current batch number | -653 | -
| ~batch | -Same as "~batchprefix~batchnum" | -Prod-653 | -
| ~batchposition | -The current batch position, or "Roast of the Day" | -9 | -
| ~batch_long | -Same as Batch field in Roast Properties "~batchprefix~batchnum (~batchposition)" |
- Prod-653 (9) | -
| ~title | -From Roast>Properties>Title | -Ethiopia Guji | -
| ~beans_nn | -Replace “nn” with 10, 15, 20, 25, or 30 to show the first “nn” characters of the Beans field. From Roast>Properties>Beans |
- Ethiopia G | -
| ~beans_line | -The entire first line From Roast>Properties>Beans | -Ethiopia Guji purchased from Royal | -
| ~date | -Roast date in format yy-MM-dd | -20-02-05 | -
| ~date_long | -Roast date in format yyyy-MM-dd | -2020-02-05 | -
| ~time | -Roast time in format hhmm | -1742 | -
| ~datetime | -Roast date and time in format yy-MM-dd_hhmm | -20-02-05_1742 | -
| ~datetime_long | -Roast date and time in format yyyy-MM-dd_hhmm | -2020-02-05_1742 | -
| ~yyyy | -Roast year in format yyyy | -2020 | -
| ~yy | -Roast year in format yy | -20 | -
| ~mmm | -Roast month in format MMM (localized) | -Feb | -
| ~mm | -Roast month in format MM | -02 | -
| ~ddd | -Roast day in format ddd (localized) | -Wed | -
| ~dd | -Roast day in format dd | -05 | -
| ~hour | -Roast hour in format hh | -17 | -
| ~minute | -Roast minute in format mm | -42 | -
| ~currtime | -Current date and time with seconds in format yy-MM-dd_hhmmss. Not the same as roast time. | -21-01-18_093609 | -
| ~operator | -From Roast>Properties>Operator | -Dave | -
| ~organization | -From Roast>Properties>Organization | -Dave's Coffee | -
| ~machine | -From Roast>Properties>Machine | -SF-6 | -
| ~weight | -From Roast>Properties>Weight Green | -3 | -
| ~roastedweight | -From Roast>Properties>Weight Roasted | -2.6 | -
| ~weightunits | -From Roast>Properties>Weight | -Kg | -
| ~weightloss | -Calculated weight loss in percent (the “-” sign is not shown, it can be added manually in front of the field if desired) | -14.1 | -
| ~volume | -From Roast>Properties>Volume Green | -4.1 | -
| ~roastedvolume | -From Roast>Properties>Volume Roasted | -6.8 | -
| ~volumeunits | -From Roast>Properties>Volume | -l | -
| ~volumegain | -Calculated volume gain in percent | -61.5 | -
| ~density | -From Roast>Properties>Density Green | -756.4 | -
| ~roasteddensity | -From Roast>Properties>Density Roasted | -375.2 | -
| ~densityunits | -From Roast>Properties>Density | -g_l | -
| ~densityloss | -Calculated density loss in percent (the “-” sign is not shown, it can be added manually in front of the field if desired) | -46.8 | -
| ~moisture | -From Roast>Properties>Moisture Green | -11.7 | -
| ~roastedmoisture | -From Roast>Properties>Moisture Roasted | -2.8 | -
| ~moistureloss | -Calculated moisture loss in percent (the “-” sign is not shown, it can be added manually in front of the field if desired) | -8.1 | -
| ~drumspeed | -From Roast>Properties>Drum Speed | -64 | -
| ~colorwhole | -From Roast>Properties>Color Whole | -103 | -
| ~colorground | -From Roast>Properties>Color Ground | -98 | -
| ~colorsystem | -From Roast>Properties>Color System | -Tonino | -
| ~screenmin | -From Roast>Properties>Screen Min | -16 | -
| ~screenmax | -From Roast>Properties>Screen Max | -18 | -
| ~greenstemp | -From Roast>Properties>(Green) Beans Temperature | -68.0 | -
| ~ambtemp | -From Roast>Properties>Ambient Temperature | -70.0 | -
| ~ambhumidity | -From Roast>Properties>Ambient Humidity | -35.1 | -
| ~ambpressure | -From Roast>Properties>Ambient Pressure | -1023.8 | -
| ~devtime | -Calculated time from FCs to DROP in seconds | -112 | -
| ~devtime_long | -Calculated time from FCs to DROP in min_secs | -01_52 | -
| ~dtr | -From Profile Statistics - DTR (in percent) | -22.1 | -
| ~auc | -From the Profile Statistics - AUC | -218 | -
| ~aucbase | -From the Profile Statistics - AUC Base | -300 | -
| ~mode | -From Config>Temperature - the current temperature mode C or F. | -F | -
| ~chargeet | -From the Profile - ET at CHARGE | -379.4 | -
| ~chargebt | -From the Profile - BT at CHARGE | -375.2 | -
| ~fcset | -From the Profile - ET at FCs | -397.4 | -
| ~fcsbt | -From the Profile -BT at FCs | -386.7 | -
| ~fcstime | -From the Profile - FCs time in seconds | -490 | -
| ~fcstime_long | -From the Profile - FCs time in min_secs | -08_10 | -
| ~dropet | -From the Profile - ET at DROP | -378.6 | -
| ~dropbt | -From the Profile - BT at DROP | -412.5 | -
| ~droptime | -From the Profile - DROP time in seconds | -617 | -
| ~droptime_long | -From the Profile - DROP time in min_secs | -10_17 | -
| ~dryphasedeltatemp | -From the Profile - BT temperature change from TP to DRY | -121.3 | -
| ~midphasedeltatemp | -From the Profile - BT temperature change from DRY to FCs | -78.6 | -
| ~finishphasedeltatemp | -From the Profile - BT temperature change from FCs to DROP | -19.8 | -
| ~roastingnotes_nn | -Replace “nn” with 10, 15, 20, 25, or 30 to show the first “nn” characters of the Roasting Notes field. From Roast>Properties>Roasting Notes |
- No crash, | -
| ~roastingnotes_line | -The entire first line From Roast>Properties>Roasting Notes | -No crash, maintained RoR | -
| ~cuppingnotes_nn | -Replace “nn” with 10, 15, 20, 25, or 30 to show the first “nn” characters of the Cupping Notes field. From Roast>Properties>Cupping Notes |
- Lots of be | -
| ~cuppingnotes_line | -The entire first line From Roast>Properties>Cupping Notes | -Lots of berries and chocolate | -
| ~btubatch | -From the Profile Energy Use - Total energy used by the batch in BTU | -8943.2 | -
| ~co2batch | -From the Profile Energy Use - CO2 produced by the batch in g | -923.3 | -
| ~btupreheat | -From the Profile Energy Use - Energy used during preheat in BTU | -2538.8 | -
| ~co2preheat | -From the Profile Energy Use - CO2 produced during preheat in g | -443.9 | -
| ~btubbp | -From the Profile Energy Use - Energy used during Between Batch Protocol in BTU | -1019.7 | -
| ~co2bbp | -From the Profile Energy Use - CO2 produced during Between Batch Protocol in g | -254.1 | -
| ~bturoast | -From the Profile Energy Use - Energy used from CHARGE to DROP in BTU | -7843.2 | -
| ~co2roast | -From the Profile Energy Use - CO2 produced from CHARGE to DROP in g | -873.9 | -
| ~co2pergreenkg | -From the Profile Energy Use - CO2 produced per kg of green beans in g | -354.3 | -
| NOTES: Anything between single quotes ' will show in the file name only when ON. Example: 'REC ~batch' Anything between double quotes " will show in the file name only when OFF. Example: "~operator" For backward compatibility, when the Prefix field is text only the date and time are appended to the file name. Example: 'Autosave' will result in file name 'Autosave_20-01-13_1705'. To show only the text place a single '!' at the start of the Prefix field Example: '!Autosave' will result in file name 'Autosave'. To maintain cross platform compatibility, file names may contain only letters, numbers, spaces, and the following special characters: _ - . ( ) |
-
| Data used to replace the fields in the Autosave File Name Prefix are pulled from the current Roast Properties. | -
| Autosave Field | -Example File Name | -
|---|---|
| ~title Roasted on ~date | -Burundi Roasted on 20-04-25.alog | -
| ~batchcounter ~title ~date_long | -1380 Burundi 2020-04-25_1136.alog | -
| ~beans ~machine ~drumspeedRPM ~weight~weightunits ~poisturePCT ~operator ~date ~batch(~batchposition) | -Burundi Kiganda Murambi Lot44 SF-25 64RPM 10.3Kg 10.2PCT Roberto 20-04-25 Prod-1380(6).alog | -
| ~title ~weight~weightunits ~finishphase_deltatemp~mode | -Burundi 454.0g 19.8F.alog | -
| 'Recording ~batchcounter' "~batch" ~title ~datetime_long | -When OFF: Prod-1380 Burundi Kiganda Murambi 2020-04-25_1136.alog While Recording: Recording 1380 Burundi KigandaMurambi 2020-04-25_1136.alog |
-
| 'Recording ~batchcounter' "~batch" ~title ~date_long_'~currtime'"~time" | -Creates a unique filename for multiple saves while sampling by using ~currtime. When OFF: Prod-1380 Burundi Kiganda Murambi 2020-04-25_1136.alog While Recording. Recording 1380 Burundi KigandaMurambi 2020-04-25_113809.alog |
-
| Dialog Field | +Meaning | +
|---|---|
| Autosave [a] | +Turn Autosave ON or OFF. When sampling, the keyboard 'a' will save the profile at that moment. NOTE: Files with the same file name will be silently overwritten. Use ~currdatetime in the file name prefix to get unique file names. |
+
| Add to recent file list | +When checked, Autosaved files will be added to the Files>> Open Recent files list. | +
| File Name Prefix | +Defines the file name to use for Autosave. See the Autosave Fields section below. | +
| Preview: | +Shows an example of the file name based on the File Name Prefix field. A 'While Recording:' example will also be shown if the file name will be different when the scope is sampling. |
+
| Path | +Where to store the Autosaved files. | +
| Save Also | +Allows to save an additional file. Choose the file type from the pull-down menu. | +
| Path | +Where to store the additional files. | +
| Prefix Field | +Source | +Example | +
|---|---|---|
| ~batchprefix | +The batch prefix set in Config>Batch>Prefix | +Prod- | +
| ~batchcounter | +The current batch number | +653 | +
| ~batch | +Same as "~batchprefix~batchnum" | +Prod-653 | +
| ~batchposition | +The current batch position, or "Roast of the Day" | +9 | +
| ~batch_long | +Same as Batch field in Roast Properties "~batchprefix~batchnum (~batchposition)" |
+ Prod-653 (9) | +
| ~title | +From Roast>Properties>Title | +Ethiopia Guji | +
| ~beans_nn | +Replace “nn” with 10, 15, 20, 25, or 30 to show the first “nn” characters of the Beans field. From Roast>Properties>Beans |
+ Ethiopia G | +
| ~beans_line | +The entire first line From Roast>Properties>Beans | +Ethiopia Guji purchased from Royal | +
| ~date | +Roast date in format yy-MM-dd | +20-02-05 | +
| ~date_long | +Roast date in format yyyy-MM-dd | +2020-02-05 | +
| ~time | +Roast time in format hhmm | +1742 | +
| ~datetime | +Roast date and time in format yy-MM-dd_hhmm | +20-02-05_1742 | +
| ~datetime_long | +Roast date and time in format yyyy-MM-dd_hhmm | +2020-02-05_1742 | +
| ~yyyy | +Roast year in format yyyy | +2020 | +
| ~yy | +Roast year in format yy | +20 | +
| ~mmm | +Roast month in format MMM (localized) | +Feb | +
| ~mm | +Roast month in format MM | +02 | +
| ~ddd | +Roast day in format ddd (localized) | +Wed | +
| ~dd | +Roast day in format dd | +05 | +
| ~hour | +Roast hour in format hh | +17 | +
| ~minute | +Roast minute in format mm | +42 | +
| ~currtime | +Current date and time with seconds in format yy-MM-dd_hhmmss. Not the same as roast time. | +21-01-18_093609 | +
| ~operator | +From Roast>Properties>Operator | +Dave | +
| ~organization | +From Roast>Properties>Organization | +Dave's Coffee | +
| ~machine | +From Roast>Properties>Machine | +SF-6 | +
| ~weight | +From Roast>Properties>Weight Green | +3 | +
| ~roastedweight | +From Roast>Properties>Weight Roasted | +2.6 | +
| ~weightunits | +From Roast>Properties>Weight | +Kg | +
| ~weightloss | +Calculated weight loss in percent (the “-” sign is not shown, it can be added manually in front of the field if desired) | +14.1 | +
| ~volume | +From Roast>Properties>Volume Green | +4.1 | +
| ~roastedvolume | +From Roast>Properties>Volume Roasted | +6.8 | +
| ~volumeunits | +From Roast>Properties>Volume | +l | +
| ~volumegain | +Calculated volume gain in percent | +61.5 | +
| ~density | +From Roast>Properties>Density Green | +756.4 | +
| ~roasteddensity | +From Roast>Properties>Density Roasted | +375.2 | +
| ~densityunits | +From Roast>Properties>Density | +g_l | +
| ~densityloss | +Calculated density loss in percent (the “-” sign is not shown, it can be added manually in front of the field if desired) | +46.8 | +
| ~moisture | +From Roast>Properties>Moisture Green | +11.7 | +
| ~roastedmoisture | +From Roast>Properties>Moisture Roasted | +2.8 | +
| ~moistureloss | +Calculated moisture loss in percent (the “-” sign is not shown, it can be added manually in front of the field if desired) | +8.1 | +
| ~drumspeed | +From Roast>Properties>Drum Speed | +64 | +
| ~colorwhole | +From Roast>Properties>Color Whole | +103 | +
| ~colorground | +From Roast>Properties>Color Ground | +98 | +
| ~colorsystem | +From Roast>Properties>Color System | +Tonino | +
| ~screenmin | +From Roast>Properties>Screen Min | +16 | +
| ~screenmax | +From Roast>Properties>Screen Max | +18 | +
| ~greenstemp | +From Roast>Properties>(Green) Beans Temperature | +68.0 | +
| ~ambtemp | +From Roast>Properties>Ambient Temperature | +70.0 | +
| ~ambhumidity | +From Roast>Properties>Ambient Humidity | +35.1 | +
| ~ambpressure | +From Roast>Properties>Ambient Pressure | +1023.8 | +
| ~devtime | +Calculated time from FCs to DROP in seconds | +112 | +
| ~devtime_long | +Calculated time from FCs to DROP in min_secs | +01_52 | +
| ~dtr | +From Profile Statistics - DTR (in percent) | +22.1 | +
| ~auc | +From the Profile Statistics - AUC | +218 | +
| ~aucbase | +From the Profile Statistics - AUC Base | +300 | +
| ~mode | +From Config>Temperature - the current temperature mode C or F. | +F | +
| ~chargeet | +From the Profile - ET at CHARGE | +379.4 | +
| ~chargebt | +From the Profile - BT at CHARGE | +375.2 | +
| ~fcset | +From the Profile - ET at FCs | +397.4 | +
| ~fcsbt | +From the Profile -BT at FCs | +386.7 | +
| ~fcstime | +From the Profile - FCs time in seconds | +490 | +
| ~fcstime_long | +From the Profile - FCs time in min_secs | +08_10 | +
| ~dropet | +From the Profile - ET at DROP | +378.6 | +
| ~dropbt | +From the Profile - BT at DROP | +412.5 | +
| ~droptime | +From the Profile - DROP time in seconds | +617 | +
| ~droptime_long | +From the Profile - DROP time in min_secs | +10_17 | +
| ~dryphasedeltatemp | +From the Profile - BT temperature change from TP to DRY | +121.3 | +
| ~midphasedeltatemp | +From the Profile - BT temperature change from DRY to FCs | +78.6 | +
| ~finishphasedeltatemp | +From the Profile - BT temperature change from FCs to DROP | +19.8 | +
| ~roastingnotes_nn | +Replace “nn” with 10, 15, 20, 25, or 30 to show the first “nn” characters of the Roasting Notes field. From Roast>Properties>Roasting Notes |
+ No crash, | +
| ~roastingnotes_line | +The entire first line From Roast>Properties>Roasting Notes | +No crash, maintained RoR | +
| ~cuppingnotes_nn | +Replace “nn” with 10, 15, 20, 25, or 30 to show the first “nn” characters of the Cupping Notes field. From Roast>Properties>Cupping Notes |
+ Lots of be | +
| ~cuppingnotes_line | +The entire first line From Roast>Properties>Cupping Notes | +Lots of berries and chocolate | +
| ~btubatch | +From the Profile Energy Use - Total energy used by the batch in BTU | +8943.2 | +
| ~co2batch | +From the Profile Energy Use - CO2 produced by the batch in g | +923.3 | +
| ~btupreheat | +From the Profile Energy Use - Energy used during preheat in BTU | +2538.8 | +
| ~co2preheat | +From the Profile Energy Use - CO2 produced during preheat in g | +443.9 | +
| ~btubbp | +From the Profile Energy Use - Energy used during Between Batch Protocol in BTU | +1019.7 | +
| ~co2bbp | +From the Profile Energy Use - CO2 produced during Between Batch Protocol in g | +254.1 | +
| ~bturoast | +From the Profile Energy Use - Energy used from CHARGE to DROP in BTU | +7843.2 | +
| ~co2roast | +From the Profile Energy Use - CO2 produced from CHARGE to DROP in g | +873.9 | +
| ~co2pergreenkg | +From the Profile Energy Use - CO2 produced per kg of green beans in g | +354.3 | +
| NOTES: Anything between single quotes ' will show in the file name only when ON. Example: 'REC ~batch' Anything between double quotes " will show in the file name only when OFF. Example: "~operator" For backward compatibility, when the Prefix field is text only the date and time are appended to the file name. Example: 'Autosave' will result in file name 'Autosave_20-01-13_1705'. To show only the text place a single '!' at the start of the Prefix field Example: '!Autosave' will result in file name 'Autosave'. To maintain cross platform compatibility, file names may contain only letters, numbers, spaces, and the following special characters: _ - . ( ) |
+
| Data used to replace the fields in the Autosave File Name Prefix are pulled from the current Roast Properties. | +
| Autosave Field | +Example File Name | +
|---|---|
| ~title Roasted on ~date | +Burundi Roasted on 20-04-25.alog | +
| ~batchcounter ~title ~date_long | +1380 Burundi 2020-04-25_1136.alog | +
| ~beans ~machine ~drumspeedRPM ~weight~weightunits ~poisturePCT ~operator ~date ~batch(~batchposition) | +Burundi Kiganda Murambi Lot44 SF-25 64RPM 10.3Kg 10.2PCT Roberto 20-04-25 Prod-1380(6).alog | +
| ~title ~weight~weightunits ~finishphase_deltatemp~mode | +Burundi 454.0g 19.8F.alog | +
| 'Recording ~batchcounter' "~batch" ~title ~datetime_long | +When OFF: Prod-1380 Burundi Kiganda Murambi 2020-04-25_1136.alog While Recording: Recording 1380 Burundi KigandaMurambi 2020-04-25_1136.alog |
+
| 'Recording ~batchcounter' "~batch" ~title ~date_long_'~currtime'"~time" | +Creates a unique filename for multiple saves while sampling by using ~currtime. When OFF: Prod-1380 Burundi Kiganda Murambi 2020-04-25_1136.alog While Recording. Recording 1380 Burundi KigandaMurambi 2020-04-25_113809.alog |
+
| The Energy tab displays a roast's energy consumption. CO2 emissions are also calculated to monitor the impact of the roasting operation. Settings must be made for each energy load. Loads are the main burners, motors and blowers, and an afterburner if one is used. The energy used for pre-heating, between batch, and roaster cooling protocols are included in the calculations, and settings are available for them as well. Note that pre-heating and roaster cooling energy values are applied to the first roast of a roasting session. Between batch energies are applied to every roast except the first. Tick the "Between batches after Pre-Heating box to apply the between batch value to the first roast. Follow the steps below to set the energy inputs for the roast machine and afterburner. Blank entries are the same as a zero entry. Negative values are not allowed. |
-
| Once you set up the Loads sub-tab and the Protocols sub-tab, it is a good idea to click "Save Defaults" on both sub-tabs (they are saved separately). When loading a profile with existing energy values, the profile settings will be read and will overwrite the values on the Loads and Profiles sub-tabs. Having them saved as defaults allow for them to be quickly restored by clicking "Restore Defaults" on each sub-tab. | -
| This sub-tab shows a detailed table of the energy consumption and CO2 production data for the roast. The values in this table are based on current Profile and the settings made on the Loads and Protocols sub-tabs. Columns may be sorted by clicking on the column title. To return to original sort click on the 'Kind' column title. | -
| Field | -Description | -
|---|---|
| Results in | -Choose the energy units for the summary displays and the Details sub-tab. | -
| Begin by making entries on the Loads sub-tab to define the sources of energy used by this roast. It might be a good idea to save those settings as defaults to be used to calculate the energy consumption of future roasts Power ratings for up to four energy loads may be entered. Loads will be the main burners or heaters, motors and blowers, and the afterburner if one is used. Enter one load per line. Motors and blowers that run continuously may be aggregated and entered as one load. Loads are assumed to run continuously. Variable loads, such as the main burner setting, can be recorded in Artisan using one of the four special events. The settings can be captured from a button, slider or in some cases read directly from the roaster. The load setup allows linking a load to one of these events. The energy calculator will then determine the setting percentage and the duration of the setting to calculate the energy consumed. Burner entries require knowing the power rating of the burner. Roasting machine manufacturer's typically provide this information. If this information can not be found for your machine this table provides approximate values based on roaster capacities. https://artisan-scope.org/ratings/ |
-
| Field | -Description | -
|---|---|
| Label | -Enter your personal description for this burner. Examples are 'Main' and 'Afterburner'. | -
| Rating | -This is the power rating of the load Choose the units in the next column. | -
| Unit | -Select the appropriate power unit. Some manufacturers incorrectly use BTU. In that case use BTU/h for the unit. | -
| Fuel | -Select the type of fuel used by this load 'Elec' is assumed to be electricity generated from dirty coal. There is a setting below to adjust for renewable clean energy sources. | -
| Event | -Special Events are often used to record load settings, such as a burner setting, in the roast profile. Select the Event that corresponds to the load setting here. When blank the load is assumed to be at a constant setting, which is the percent 'Value 100%' multiplied by the rating. A 10 kW load at '100% Value'= 60 would thus be 10 kW * 60% = 6 kW. Continuous loads are typically motors and blowers and the afterburner. |
-
| Pressure % | -For gas loads tick this box when the readings are made in units of pressure. Some roasters and some controllers provide readings in heat energy. When the readings are made in heat energy leave this box unticked. | -
| Value 0% | -When an Event is selected in the previous column this value can be set to match the 0% burner setting to the event setting. In most cases a 0 Event value will correspond to the 0% load setting. | -
| Value 100% | -When an Event is selected this value can be set to match the 100% load setting to the event setting. This is useful when the 100% load setting is recorded as a different number in the Event. For instance, maybe the burner event is recorded as 10x the kPa reading on the gas manometer. An event value of 35 is recoded to signify 3.5 kPa, which is 50% pressure. If the 100% burner setting corresponds to 7 kPa then the 'Value 100%' should be set to 70, which is 7 * 10 = 70. Thus 3.5 kPa will be seen by he energy calculator as 50%. For pressure readings be sure to tick the Pressure box. Heat energy readings are normally 0%-100% and do not require any adjustment to this setting. | -
| Electric Energy Mix | -This setting allows to set a mix of renewable energy that sources the electric loads. 0% assumes all the energy comes from burning dirty coal and maximizes the CO2 in the calculations. 100% assumes the energy comes only from renewable sources with no CO2 produced. | -
| Save Defaults | -Stores the current settings on this sub-tab as defaults to be recalled later. The default values will be stored when saving settings (Help>Save Settings) to a file. | -
| Restore Defaults | -Overwrites the values on this sub-tab with those stored as the defaults. When a profile with energy settings is opened, the values on this tab will be read from the profile. They will be overwritten when clicking Restore Defaults. | -
| The Protocol settings allow including Pre-Heating, Between Batch (BBP) and Cooling protocol energy consumption. There are two ways to specify these values. The first assumes a constant load setting for a defined period of time. An example for pre-heating is to set a Duration of 45:00 (45 minutes) at 30% Burner setting. Percentages must be entered with the percent sign (30%). When a percentage is entered a corresponding Duration must be entered. The second type of entry is a "measured" energy value. This can be any value greater than 1.0. Artisan can inspect the open profile to determine energy values for each Load that is associated with an Event on the Loads sub-tab. Click the [...] button for each Protocol to auto fill the Measured Energy fields. The Artisan measurements for Pre-Heating and Between Batches are made from the start of the profile until CHARGE. If there is no CHARGE event the measurement is from the start to the end of profile. The values measured for Pre-Heating and Between Batches are the same. Be sure you do not use the same profile to enter both values. The Cooling energy is measured from DROP to the end of the profile. If there is no DROP event the measurement begins at CHARGE. If there is no CHARGE event the measurement is from the start to the end of the profile. To use the Artisan energy measurement feature you will need to record one or more profiles that include the protocol of interest. For example, to measure the Pre-Heating energy, START recording when the roaster is turned on. Let Artisan record the entire pre-heating procedure. At the end of the pre-heating you can either STOP recording the profile or go forward with the roast. The CHARGE event will mark the end of pre-heating when Artisan measures the pre-heat energy. Similarly a Between Batches protocol can be recorded with START followed by a normal roast. A Cooling protocol would be captured by not turning the Artisan recording OFF until the roaster is fully cooled. The Artisan measurements for Pre-Heating and Between Batches are made from the start of the profile until CHARGE. If there is no CHARGE event the measurement is from the start to the end of profile. The values measured for Pre-Heating and Between Batches are the same. Be sure you do not use the same profile to enter both values. The Cooling energy is measured from DROP to the end of the profile. If there is no DROP event the measurement begins at CHARGE. If there is no CHARGE event the measurement is from the start to the end of the profile. |
-
| Field | -Description | -
|---|---|
| Pre-Heating | -This row sets the values for pre-heating energy. Percentage or measured values may be entered for each burner. When a percentage is used the Duration field must be set. Pre-Heating energy is applied only to the first batch of a roasting session. |
-
| Between Batches | -This row sets the values for between batches protocol for the roasting session. Percentage or measured values may be entered for each burner. When a percentage is used the Duration field must be set. Between Batches energy is applied to each batch of the roasting session, except the first batch. Tick the 'Between Batches after Pre-Heating' box to apply Between Batches energies to the first batch of the session too. |
-
| Cooling | -This row sets the values for the energy used for cooling. Most common loads are motors and blowers that consume energy during the roaster cool down period. Percentage or measured values may be entered for each burner. When a percentage is used the Duration field must be set. Pre-Heating energy is applied only to the first batch of a roasting session. |
-
| Duration | -The length (mm:ss) of protocol. It is used with a burner's percentage setting to calculate the energy consumed by that burner. When a percentage entry is made for the burner, the Duration field must be set. | -
| Measured Energy or Output % | -The value is either the measured energy for the protocol or the burner constant percentage setting for the length of the Duration field. | -
| Measure Profile [...] | -Energy is measured from the open profile for each load where an event is specified on the Loads tab. Click OK to auto fill in the associated Measured Energy field. | -
| Between Batches after Pre-Heating | -This box should be ticked when a Between Batches protocol run is done after the Pre-heating and before the roast. | -
| Save Defaults | -Stores the current settings on this sub-tab as defaults to be recalled later. The default values will be stored when saving settings (Help>Save Settings) to a file. | -
| Restore Defaults | -Overwrites the values on this sub-tab with those stored as the defaults. When a profile with energy settings is opened, the values on this tab will be read from the profile. They will be overwritten when clicking Restore Defaults. | -
| The Energy tab displays a roast's energy consumption. CO2 emissions are also calculated to monitor the impact of the roasting operation. Settings must be made for each energy load. Loads are the main burners, motors and blowers, and an afterburner if one is used. The energy used for pre-heating, between batch, and roaster cooling protocols are included in the calculations, and settings are available for them as well. Note that pre-heating and roaster cooling energy values are applied to the first roast of a roasting session. Between batch energies are applied to every roast except the first. Tick the "Between batches after Pre-Heating box to apply the between batch value to the first roast. Follow the steps below to set the energy inputs for the roast machine and afterburner. Blank entries are the same as a zero entry. Negative values are not allowed. |
+
| Once you set up the Loads sub-tab and the Protocols sub-tab, it is a good idea to click "Save Defaults" on both sub-tabs (they are saved separately). When loading a profile with existing energy values, the profile settings will be read and will overwrite the values on the Loads and Profiles sub-tabs. Having them saved as defaults allow for them to be quickly restored by clicking "Restore Defaults" on each sub-tab. | +
| This sub-tab shows a detailed table of the energy consumption and CO2 production data for the roast. The values in this table are based on current Profile and the settings made on the Loads and Protocols sub-tabs. Columns may be sorted by clicking on the column title. To return to original sort click on the 'Kind' column title. | +
| Field | +Description | +
|---|---|
| Results in | +Choose the energy units for the summary displays and the Details sub-tab. | +
| Begin by making entries on the Loads sub-tab to define the sources of energy used by this roast. It might be a good idea to save those settings as defaults to be used to calculate the energy consumption of future roasts Power ratings for up to four energy loads may be entered. Loads will be the main burners or heaters, motors and blowers, and the afterburner if one is used. Enter one load per line. Motors and blowers that run continuously may be aggregated and entered as one load. Loads are assumed to run continuously. Variable loads, such as the main burner setting, can be recorded in Artisan using one of the four special events. The settings can be captured from a button, slider or in some cases read directly from the roaster. The load setup allows linking a load to one of these events. The energy calculator will then determine the setting percentage and the duration of the setting to calculate the energy consumed. Burner entries require knowing the power rating of the burner. Roasting machine manufacturer's typically provide this information. If this information can not be found for your machine this table provides approximate values based on roaster capacities. https://artisan-scope.org/ratings/ |
+
| Field | +Description | +
|---|---|
| Label | +Enter your personal description for this burner. Examples are 'Main' and 'Afterburner'. | +
| Rating | +This is the power rating of the load Choose the units in the next column. | +
| Unit | +Select the appropriate power unit. Some manufacturers incorrectly use BTU. In that case use BTU/h for the unit. | +
| Fuel | +Select the type of fuel used by this load 'Elec' is assumed to be electricity generated from dirty coal. There is a setting below to adjust for renewable clean energy sources. | +
| Event | +Special Events are often used to record load settings, such as a burner setting, in the roast profile. Select the Event that corresponds to the load setting here. When blank the load is assumed to be at a constant setting, which is the percent 'Value 100%' multiplied by the rating. A 10 kW load at '100% Value'= 60 would thus be 10 kW * 60% = 6 kW. Continuous loads are typically motors and blowers and the afterburner. |
+
| Pressure % | +For gas loads tick this box when the readings are made in units of pressure. Some roasters and some controllers provide readings in heat energy. When the readings are made in heat energy leave this box unticked. | +
| Value 0% | +When an Event is selected in the previous column this value can be set to match the 0% burner setting to the event setting. In most cases a 0 Event value will correspond to the 0% load setting. | +
| Value 100% | +When an Event is selected this value can be set to match the 100% load setting to the event setting. This is useful when the 100% load setting is recorded as a different number in the Event. For instance, maybe the burner event is recorded as 10x the kPa reading on the gas manometer. An event value of 35 is recoded to signify 3.5 kPa, which is 50% pressure. If the 100% burner setting corresponds to 7 kPa then the 'Value 100%' should be set to 70, which is 7 * 10 = 70. Thus 3.5 kPa will be seen by he energy calculator as 50%. For pressure readings be sure to tick the Pressure box. Heat energy readings are normally 0%-100% and do not require any adjustment to this setting. | +
| Electric Energy Mix | +This setting allows to set a mix of renewable energy that sources the electric loads. 0% assumes all the energy comes from burning dirty coal and maximizes the CO2 in the calculations. 100% assumes the energy comes only from renewable sources with no CO2 produced. | +
| Save Defaults | +Stores the current settings on this sub-tab as defaults to be recalled later. The default values will be stored when saving settings (Help>Save Settings) to a file. | +
| Restore Defaults | +Overwrites the values on this sub-tab with those stored as the defaults. When a profile with energy settings is opened, the values on this tab will be read from the profile. They will be overwritten when clicking Restore Defaults. | +
| The Protocol settings allow including Pre-Heating, Between Batch (BBP) and Cooling protocol energy consumption. There are two ways to specify these values. The first assumes a constant load setting for a defined period of time. An example for pre-heating is to set a Duration of 45:00 (45 minutes) at 30% Burner setting. Percentages must be entered with the percent sign (30%). When a percentage is entered a corresponding Duration must be entered. The second type of entry is a "measured" energy value. This can be any value greater than 1.0. Artisan can inspect the open profile to determine energy values for each Load that is associated with an Event on the Loads sub-tab. Click the [...] button for each Protocol to auto fill the Measured Energy fields. The Artisan measurements for Pre-Heating and Between Batches are made from the start of the profile until CHARGE. If there is no CHARGE event the measurement is from the start to the end of profile. The values measured for Pre-Heating and Between Batches are the same. Be sure you do not use the same profile to enter both values. The Cooling energy is measured from DROP to the end of the profile. If there is no DROP event the measurement begins at CHARGE. If there is no CHARGE event the measurement is from the start to the end of the profile. To use the Artisan energy measurement feature you will need to record one or more profiles that include the protocol of interest. For example, to measure the Pre-Heating energy, START recording when the roaster is turned on. Let Artisan record the entire pre-heating procedure. At the end of the pre-heating you can either STOP recording the profile or go forward with the roast. The CHARGE event will mark the end of pre-heating when Artisan measures the pre-heat energy. Similarly a Between Batches protocol can be recorded with START followed by a normal roast. A Cooling protocol would be captured by not turning the Artisan recording OFF until the roaster is fully cooled. The Artisan measurements for Pre-Heating and Between Batches are made from the start of the profile until CHARGE. If there is no CHARGE event the measurement is from the start to the end of profile. The values measured for Pre-Heating and Between Batches are the same. Be sure you do not use the same profile to enter both values. The Cooling energy is measured from DROP to the end of the profile. If there is no DROP event the measurement begins at CHARGE. If there is no CHARGE event the measurement is from the start to the end of the profile. |
+
| Field | +Description | +
|---|---|
| Pre-Heating | +This row sets the values for pre-heating energy. Percentage or measured values may be entered for each burner. When a percentage is used the Duration field must be set. Pre-Heating energy is applied only to the first batch of a roasting session. |
+
| Between Batches | +This row sets the values for between batches protocol for the roasting session. Percentage or measured values may be entered for each burner. When a percentage is used the Duration field must be set. Between Batches energy is applied to each batch of the roasting session, except the first batch. Tick the 'Between Batches after Pre-Heating' box to apply Between Batches energies to the first batch of the session too. |
+
| Cooling | +This row sets the values for the energy used for cooling. Most common loads are motors and blowers that consume energy during the roaster cool down period. Percentage or measured values may be entered for each burner. When a percentage is used the Duration field must be set. Pre-Heating energy is applied only to the first batch of a roasting session. |
+
| Duration | +The length (mm:ss) of protocol. It is used with a burner's percentage setting to calculate the energy consumed by that burner. When a percentage entry is made for the burner, the Duration field must be set. | +
| Measured Energy or Output % | +The value is either the measured energy for the protocol or the burner constant percentage setting for the length of the Duration field. | +
| Measure Profile [...] | +Energy is measured from the open profile for each load where an event is specified on the Loads tab. Click OK to auto fill in the associated Measured Energy field. | +
| Between Batches after Pre-Heating | +This box should be ticked when a Between Batches protocol run is done after the Pre-heating and before the roast. | +
| Save Defaults | +Stores the current settings on this sub-tab as defaults to be recalled later. The default values will be stored when saving settings (Help>Save Settings) to a file. | +
| Restore Defaults | +Overwrites the values on this sub-tab with those stored as the defaults. When a profile with energy settings is opened, the values on this tab will be read from the profile. They will be overwritten when clicking Restore Defaults. | +
| Prefix Field | -Source | -Example | -
|---|---|---|
| ~E | -The value of Event | -60 | -
| ~Y1 | -ET value | -420 | -
| ~Y2 | -BT value | -372 | -
| ~descr | -The Description field of the Event | -Gas 10 | -
| ~type | -The Type field of the Event | -Power | -
| ~sldrunit | -The value of the Slider Unit for this Event | -kPa | -
| ~dCHARGE | -Number of seconds before or after CHARGE Before CHARGE shows negative Displays '*' when no CHARGE event exists |
- 522 | -
| ~dCHARGE_ms | -Time before or after CHARGE in min:sec Before CHARGE shows negative Displays '*' when no CHARGE event exists |
- 8:42 | -
| ~dFCs | -Number of seconds before or after FCs Best used inside double quotes (see notes below) Negative value before FCs Displays '*' when no FCs event exists |
- 47 | -
| ~dFCs_ms | -Time after FCs in min:sec Best used inside double quotes (see notes below) Negative value before FCs Displays '*' when no FCs event exists |
- 1:35 | -
| ~preFCs | -Number of seconds before FCs Best used inside single quotes or back ticks (see notes below) Positive value only Displays '*' after FCs or when no FCs event exists |
- 50 | -
| ~preFCs_ms | -Time before FCs in min:sec Best used inside single quotes or back ticks (see notes below) Positive value only Displays '*' after FCs or when no FCs event exists |
- 1:25 | -
| ~DTR | -Development time ratio (percent). Note: DTR=0 before FCs 100*(t{Event}-t{FCs})/(t{FCs}-t{CHARGE}) |
- 12 | -
| ~deg | -The degree symbol | -° | -
| ~mode | -Temperature mode ('C' or 'F') | -F | -
| ~degmode | -Degree symbol with Temperature mode | -°C | -
| ~R1 | -ET RoR value Displays '--' when the RoR value is not available. |
- 9.9 | -
| ~R2 | -BT RoR value Shows '--' when the RoR value Is not available. |
- 18.2 | -
| ~degmin | -RoR units Shorthand for '~deg~mode/min' |
- °C/min | -
| ~R1degmin | -ET RoR with units Field is hidden when the RoR value is not available. |
- 9.9°C/min | -
| ~R2degmin | -BT RoR with units Field is hidden when the RoR value is not available. |
- 18.2°C/min | -
| ~quot | -Quote symbol | -" | -
| ~squot | -Single quote symbol | -' | -
| Assumptions: The event value is 50. In the case of Gas the value 50 corresponds to either 5.0kPh or 50%. For a sensory milestone (see notes above) the value 50 corresponds to the "Hay" aroma. |
-
| Annotation Field | -Displays | -
|---|---|
| Gas ~E @~Y2~degmode | -Gas 50 @340°F | -
| Gas ~E% @~Y2~mode | -Gas 50% @340F | -
| Gas ~E/10kPh @~Y2~mode | -Gas 5.0kPh @340F | -
| Gas ~E/10kPh @~Y2~mode and ~R2~degmin | -Gas 5.0kPh @340F and 32.8°F/min | -
| Gas ~E% '@~Y2 ~degmode'"@~DTR% DTR" | -Before FCs: Gas 50% @340 °F After FCs: Gas 50% @12% DTR |
-
| Gas ~E% '@~Y2 ~degmode`, ~preFCs sec before FCs`'"@~DTR% DTR" | -More than 90 seconds before FCs: Gas 50% @340 °F Less than 90 seconds before FCs: Gas 50% @340 °F, 50 sec before FCs After FCs: Gas 50% @12% DTR |
-
| {20Fresh Cut Grass|50Hay|80Baking Bread|100A Point} @~Y2~degmode | -Hay @340 °F | -
| - |
|---|
| Event annotations apply only for 'Step' and 'Step+' Events settings | -
| Anything between double quotes " will show only after FCs. Example: "~E1 @~DTR%" | -
| Anything between single quotes ' will show only before FCs. Example: '~E1 @~degmode' | -
| Anything between back ticks ` will show only within 90 seconds before FCs. Example: `~E1 `FCs~dFCs sec` | -
| When combining back ticks with single or double quotes the back ticks should be inside the quotes. | -
| Background event annotations can be seen during a roast when 'Annotations' is checked in the Profile Background window. | -
| Simple scaling of the event value is possible. Use a single math operator ('*', '/', '+' or '-') immediately following the field name "E". For example: '~E/10' will divide the E value by 10. '~E+5' adds 5 to the the value of E. |
-
| Another style of annotations allows to replace an event's numeric value with a text string, known as a nominal value. One example where this can be useful is when an event is used to record sensory milestones. The value 20 might be used for 'Fresh Cut Grass' aroma, 50 for 'Hay', 80 for 'Baking Bread', and 100 to represent the 'A Point'. This form of annotation must be enclosed in curly brackets '{}'. Entries are numeric values immediately followed by their nominal representation text. Entries are separated by the vertical bar '|'. The following Annotation string implements this example. {~E|20Fresh Cut Grass|50Hay|80Baking Bread|100A Point} Note that if the event value does not match any value in the Annotation definition a blank string will be returned. In the example above an event value of 30 will return a blank string. The easiest way to ensure these values match is to use Custom Buttons to for the Event. |
-
| When annotations overlap to the point they can not be read, try reducing the value of the 'Allowed Annotation Overlap' found on the Annotations configuration page. The default value for this setting is 100%. | -
| Prefix Field | +Source | +Example | +
|---|---|---|
| ~E | +The value of Event | +60 | +
| ~Y1 | +ET value | +420 | +
| ~Y2 | +BT value | +372 | +
| ~descr | +The Description field of the Event | +Gas 10 | +
| ~type | +The Type field of the Event | +Power | +
| ~sldrunit | +The value of the Slider Unit for this Event | +kPa | +
| ~dCHARGE | +Number of seconds before or after CHARGE Before CHARGE shows negative Displays '*' when no CHARGE event exists |
+ 522 | +
| ~dCHARGE_ms | +Time before or after CHARGE in min:sec Before CHARGE shows negative Displays '*' when no CHARGE event exists |
+ 8:42 | +
| ~dFCs | +Number of seconds before or after FCs Best used inside double quotes (see notes below) Negative value before FCs Displays '*' when no FCs event exists |
+ 47 | +
| ~dFCs_ms | +Time after FCs in min:sec Best used inside double quotes (see notes below) Negative value before FCs Displays '*' when no FCs event exists |
+ 1:35 | +
| ~preFCs | +Number of seconds before FCs Best used inside single quotes or back ticks (see notes below) Positive value only Displays '*' after FCs or when no FCs event exists |
+ 50 | +
| ~preFCs_ms | +Time before FCs in min:sec Best used inside single quotes or back ticks (see notes below) Positive value only Displays '*' after FCs or when no FCs event exists |
+ 1:25 | +
| ~DTR | +Development time ratio (percent). Note: DTR=0 before FCs 100*(t{Event}-t{FCs})/(t{FCs}-t{CHARGE}) |
+ 12 | +
| ~deg | +The degree symbol | +° | +
| ~mode | +Temperature mode ('C' or 'F') | +F | +
| ~degmode | +Degree symbol with Temperature mode | +°C | +
| ~R1 | +ET RoR value Displays '--' when the RoR value is not available. |
+ 9.9 | +
| ~R2 | +BT RoR value Shows '--' when the RoR value Is not available. |
+ 18.2 | +
| ~degmin | +RoR units Shorthand for '~deg~mode/min' |
+ °C/min | +
| ~R1degmin | +ET RoR with units Field is hidden when the RoR value is not available. |
+ 9.9°C/min | +
| ~R2degmin | +BT RoR with units Field is hidden when the RoR value is not available. |
+ 18.2°C/min | +
| ~quot | +Quote symbol | +" | +
| ~squot | +Single quote symbol | +' | +
| Assumptions: The event value is 50. In the case of Gas the value 50 corresponds to either 5.0kPh or 50%. For a sensory milestone (see notes above) the value 50 corresponds to the "Hay" aroma. |
+
| Annotation Field | +Displays | +
|---|---|
| Gas ~E @~Y2~degmode | +Gas 50 @340°F | +
| Gas ~E% @~Y2~mode | +Gas 50% @340F | +
| Gas ~E/10kPh @~Y2~mode | +Gas 5.0kPh @340F | +
| Gas ~E/10kPh @~Y2~mode and ~R2~degmin | +Gas 5.0kPh @340F and 32.8°F/min | +
| Gas ~E% '@~Y2 ~degmode'"@~DTR% DTR" | +Before FCs: Gas 50% @340 °F After FCs: Gas 50% @12% DTR |
+
| Gas ~E% '@~Y2 ~degmode`, ~preFCs sec before FCs`'"@~DTR% DTR" | +More than 90 seconds before FCs: Gas 50% @340 °F Less than 90 seconds before FCs: Gas 50% @340 °F, 50 sec before FCs After FCs: Gas 50% @12% DTR |
+
| {20Fresh Cut Grass|50Hay|80Baking Bread|100A Point} @~Y2~degmode | +Hay @340 °F | +
| + |
|---|
| Event annotations apply only for 'Step' and 'Step+' Events settings | +
| Anything between double quotes " will show only after FCs. Example: "~E1 @~DTR%" | +
| Anything between single quotes ' will show only before FCs. Example: '~E1 @~degmode' | +
| Anything between back ticks ` will show only within 90 seconds before FCs. Example: `~E1 `FCs~dFCs sec` | +
| When combining back ticks with single or double quotes the back ticks should be inside the quotes. | +
| Background event annotations can be seen during a roast when 'Annotations' is checked in the Profile Background window. | +
| Simple scaling of the event value is possible. Use a single math operator ('*', '/', '+' or '-') immediately following the field name "E". For example: '~E/10' will divide the E value by 10. '~E+5' adds 5 to the the value of E. |
+
| Another style of annotations allows to replace an event's numeric value with a text string, known as a nominal value. One example where this can be useful is when an event is used to record sensory milestones. The value 20 might be used for 'Fresh Cut Grass' aroma, 50 for 'Hay', 80 for 'Baking Bread', and 100 to represent the 'A Point'. This form of annotation must be enclosed in curly brackets '{}'. Entries are numeric values immediately followed by their nominal representation text. Entries are separated by the vertical bar '|'. The following Annotation string implements this example. {~E|20Fresh Cut Grass|50Hay|80Baking Bread|100A Point} Note that if the event value does not match any value in the Annotation definition a blank string will be returned. In the example above an event value of 30 will return a blank string. The easiest way to ensure these values match is to use Custom Buttons to for the Event. |
+
| When annotations overlap to the point they can not be read, try reducing the value of the 'Allowed Annotation Overlap' found on the Annotations configuration page. The default value for this setting is 100%. | +
| Button numbers can be drag and dropped to a new position. While holding the ALT key (Windows) / OPTION (macOS) buttons are swapped |
-
| Column | -Description | -
|---|---|
| Button Label | -Enter \n to create labels with multiple lines. \t is substituted by the event type. | -
| Event Description | -Description of the Event to be recorded. | -
| Event Type | -Event type to be recorded or leave blank for no event. '±' types add a chosen offset (positive or negative) to the present value of the chosen event. | -
| Event Value | -Value of event (1-100) to be recorded. | -
| Action | -Perform an action at the time of the event. | -
| Documentation | -The action Command. Depends on the action type, '{}' is replaced by the event value and the offset in case of a ± event type. | -
| Button Visibility | -Hides/shows individual button. | -
| Option | -Description | -
|---|---|
| Max buttons per row | -Sets a maximum number of buttons to display on a single row. | -
| Button size | -Sets a size for the buttons. Choices are tiny, small and large. | -
| Color Pattern | -Applies one of 99 autogenerated color patterns to the buttons. Set to "0" to manually choose the button colors. | -
| Mark Last Pressed | -Invert state and color of last button pressed | -
| Tooltips | -Show button specification as tooltips on hovering a button | -
| Add | -Adds a new button to the bottom of the table. | -
| Insert | -Inserts a new button above the selected button. | -
| Delete | -Deletes the selected button. | -
| Copy Table | -Copy the button table in tab separated format to the clipboard. Option or ALT click to copy a tabular format to the clipboard. | -
| Help | -Opens this window. | -
| The following substitutions are applied to button labels |
-
| String | -Substitution | -
|---|---|
| \n | -New line character | -
| \t | -Event name (translated if using default event names) | -
| \q | -Event type 1 | -
| \w | -Event type 2 | -
| \e | -Event type 3 | -
| \r | -Event type 4 | -
| \0 | -OFF (translated) | -
| \1 | -ON (translated) | -
| \2 | -OFF (translated, respecting button state) | -
| \3 | -ON (translated, respecting button state) | -
| \p | -STOP (translated) | -
| \s | -START (translated) | -
| \P | -STOP (translated, respecting button state) | -
| \S | -START (translated, respecting button state) | -
| \c | -CLOSE (translated) | -
| \o | -OPEN (translated) | -
| \C | -CLOSE (translated, respecting button state) | -
| \O | -OPEN (translated, respecting button state) | -
| \a | -AUTO (translated) | -
| \m | -MANUAL (translated) | -
| \A | -AUTO (translated, respecting button state) | -
| \M | -MANUAL (translated, respecting button state) | -
| \i | -STIRRER | -
| \f | -FILL | -
| \f | -DISCHARGE | -
| \R | -RELEASE | -
| \h | -HEATING | -
| \l | -COOLING | -
| \b | -FLAP | -
| \d | -CONTROL | -
| \V | -event value | -
| \F | -event value interpreted as temperature in Fahrenheit converted to the current temperature mode | -
| \T | -event value interpreted as temperature in Celsius converted to the current temperature mode | -
| Note: "{}" can be used as a placeholder, it will be substituted by the current button value plus the offset for ± event types. If a placeholder occurs several times in a description/command, all those occurrences are replaced by the value. Note: The placeholders {ET}, {BT}, {time}, {ETB}, {BTB}, and {WEIGHTin} will be substituted by the current ET, BT, time, ET background, BT background value, and batch size (in g) in Serial/Artisan/CallProgram/MODBUS/S7/WebSocket commands Note: Commands can be sequenced, separated by semicolons like in “<cmd1>;<cmd2>;<cmd3>” Note: All characters given as documentation to a Serial Command action are sent as one string to the connected device. If the device can interpret this string as separate commands separated by semicolon this is fine. Otherwise you can use a Multiple Event referencing a number of event buttons (using a comma separated list of event button numbers as documentation string) where each of the referenced event buttons issues one of the commands via a corresponding Serial Command action. Those event buttons can be hidden thus having the same effect as if the Serial Command allowed a sequence of commands. Note: In PHIDGET commands, the optional parameter <sn> has the form <hub_serial>[:<hub_port>] allows to refer to a specific Phidget HUB by given its serial number, and optionally specifying the port number the addressed module is connected to. Note: In YOCTOPUCE commands, the optional parameter <sn> holds either the modules serial number or its name |
-
| Action | -Command | -Description | -
|---|---|---|
| Serial Command | -ASCII serial command or binary a2b_uu(serial command) | -- |
| Call Program | -A program/script path (absolute or relative) | -start an external program | -
| Multiple Event | -button numbers or sleep(<float>) separated by a comma: 1,2,sleep(2.5), 3.. | -triggers other buttons | -
| Modbus Command | -_ | -variable holding the last value read via MODBUS | -
| - | $ | -variable holding the last state of the button pressed (1 or 0) | -
| - | sleep(<float>) | -sleep: add a delay of <float> seconds | -
| - | button(i,b) | -sets button i to pressed if value b is yes, true, t, or 1, otherwise to normal | -
| - | button(<bool>) | -sets calling button to “pressed” if argument is 1 or True | -
| - | button() | -toggles the state of the button | -
| - | read(slaveID,register) | -reads 1 16bit register from slave slaveID using function 3 (Read Multiple Holding Registers) interpreted as unsigned integer. The result is bound to the placeholder `_` and thus can be accessed in later commands. | -
| - | readSigned(slaveId,register) | -reads 1 16bit register from slave slaveID using function 3 (Read Multiple Holding Registers) interpreted as signed integer. The result is bound to the placeholder `_` and thus can be accessed in later commands. | -
| - | readBCD(slaveID,register) | -reads 1 16bit register from slave slaveID using function 3 (Read Multiple Holding Registers) interpreted as BCD. The result is bound to the placeholder `_` and thus can be accessed in later commands. | -
| - | read32(slaveID,register) | -reads 2 16bit registers from slave slaveID using function 3 (Read Multiple Holding Registers) interpreted as unsigned integer. The result is bound to the placeholder `_` and thus can be accessed in later commands. | -
| - | read32Signed(slaveID,register) | -reads 2 16bit registers from slave slaveID using function 3 (Read Multiple Holding Registers) interpreted as signed integer. The result is bound to the placeholder `_` and thus can be accessed in later commands. | -
| - | read32BCD(slaveID,register) | -reads 2 16bit register from slave slaveID using function 3 (Read Multiple Holding Registers) interpreted as BCD. The result is bound to the placeholder `_` and thus can be accessed in later commands. | -
| - | readFloat(slaveID,register) | -reads 2 16bit registers from slave slaveID using function 3 (Read Multiple Holding Registers) interpreted as float. The result is bound to the placeholder `_` and thus can be accessed in later commands. | -
| - | write(slaveId,register,value) or write([slaveId,register,value],..,[slaveId,register,value]) | -write register: MODBUS function 6 (int) or function 16 (float) | -
| - | wcoil(slaveId,register,<bool>) | -write coil: MODBUS function 5 | -
| - | wcoils(slaveId,register,[<bool>,..,<bool>]) | -write coils: MODBUS function 15 | -
| - | mwrite(slaveId,register,andMask,orMask) or mwrite(s,r,am,om,v) | -mask write register: MODBUS function 22 or simulates function 22 with function 6 and the given value v | -
| - | writem(slaveId,register,value) or writem(slaveId,register,[<int>,..,<int>]) | -write registers: MODBUS function 16 | -
| - | writeBCD(s,r,v) or writeBCD([s,r,v],..,[s,r,v]) | -write 16bit BCD encoded value v to register r of slave s | -
| - | writeWord(slaveId,register,value) or writeWord([slaveId,register,value],..,[slaveId,register,value]) | -write 32bit float to two 16bit int registers: MODBUS function 16 | -
| - | writeLong(slaveId,register,value) or writeLong([slaveId,register,value],..,[slaveId,register,value]) | -write 32bit integer to two 16bit int registers: MODBUS function 16 | -
| - | writeSingle(slaveId,register,value) or writeSingle([slaveId,register,value],..,[slaveId,register,value]) | -write 16bit integer to a single 16bit register: MODBUS function 6 (int) | -
| DTA Command | -Insert Data address : value, ex. 4701:1000 and sv is 100. Always multiply with 10 if value Unit: 0.1 / ex. 4719:0 stops heating |
- - |
| IO Command | -_ | -variable holding the last result value | -
| - | $ | -variable holding the last state of the button pressed (1 or 0) | -
| - | set(c,b[,sn]) | -PHIDGET Binary Output: switches channel c off (b=0) and on (b=1) | -
| - | toggle(c[,sn]) | -PHIDGET Binary Output: toggles channel c | -
| - | pulse(c,t[,sn]) | -PHIDGET Binary Output: sets the output of channel c to on for time t in milliseconds | -
| - | out(c,v[,sn]) | -PHIDGET Voltage Output: sets voltage output of channel c to v (float) | -
| - | accel(c,v[,sn]) | -PHIDGET DCMotor: sets acceleration of channel c to v (float) | -
| - | vel(c,v[,sn]) | -PHIDGET DCMotor: sets target velocity of channel c to v (float) | -
| - | limit(c,v[,sn]) | -PHIDGET DCMotor: sets current limit of channel c to v (float) | -
| - | on(c[,sn]) | -YOCTOPUCE Relay Output: turn channel c of the relay module on | -
| - | off(c[,sn]) | -YOCTOPUCE Relay Output: turn channel c of the relay module off | -
| - | yset(c,b[,sn]) | -YOCTOPUCE Relay Output: switches channel c of the relay module off (b=0) and on (b=1) | -
| - | flip(c[,sn]) | -YOCTOPUCE Relay Output: toggle the state of channel c | -
| - | pip(c,delay,duration[,sn]) | -YOCTOPUCE Relay Output: pulse the channel c on after a delay of delay milliseconds for the duration of duration milliseconds | -
| - | powerReset([sn]) | -YOCTOPUCE resets the power counter of the Yocto-Watt module | -
| - | slider(c,v) | -move slider c to value v | -
| - | button(i,c,b[,sn]) | -switches PHIDGET Binary Output channel c off (b=0) and on (b=1) and sets button i to pressed or normal depending on the value b | -
| - | button(i,b) | -sets button i to pressed if value b is yes, true, t, or 1, otherwise to normal | -
| - | button(b) | -sets button to pressed if value b is yes, true, t, or 1, otherwise to normal | -
| - | button() | -toggles the state of the button | -
| - | sleep(<float>) | -sleep: add a delay of <float> seconds | -
| - | santoker(<target>,<value>) | -sends integer <value> to <target> register specified by as byte in hex notation like “fa” via the Santoker Network protocol | -
| - | kaleido(<target>,<value>) | -sends <value> to <target> via the Kaleido Serial or Network protocol | -
| Hottop Heater | -- | sets heater to value | -
| Hottop Fan | -- | sets fan to value | -
| Hottop Command | -motor(n),solenoid(n),stirrer(n),heater(h),fan(f) | -with n={0 ,1},h={0,..100},f={0,..10} | -
| p-i-d | -<p>;<i>;<d> | -configures PID to the values <p>;<i>;<d> | -
| Fuji Command | -write(<unitId>,<register>,<value>) | -- |
| PWM Command | -out(<channel>,<value>[,<sn>]) | -PHIDGET PWM Output: <value> in [0-100] | -
| - | toggle(<channel>[,<sn>]) | -PHIDGET PWM Output: toggles <channel> | -
| - | pulse(<channel>,<millis>[,<sn>]) | -PHIDGET PWM Output: turn <channel> on for <millis> milliseconds | -
| - | outhub(<channel>,<value>[,<sn>]) | -PHIDGET HUB PWM Output: <value> in [0-100] | -
| - | togglehub(<channel>[,<sn>]) | -PHIDGET HUB PWM Output: toggles <channel> | -
| - | pulsehub(<channel>,<millis>[,<sn>]) | -PHIDGET HUB PWM Output: turn <channel> on for <millis> milliseconds | -
| - | enabled(c,b[,sn]) | -YOCTOPUCE PWM Output: PWM running state | -
| - | freq(c,f[,sn]) | -YOCTOPUCE PWM Output: set PWM frequency to f (Hz) | -
| - | duty(c,d[,sn]) | -YOCTOPUCE PWM Output: set PWM period with the duty cycle in % as a float [0.0-100.0] | -
| - | move(c,d,t[,sn]) | -YOCTOPUCE PWM Output: changes progressively the PWM to the specified value over the given time interval | -
| VOUT Command | -range(c,r[,sn]) | -for PHIDGET OUTPUT modules: sets voltage voltage range (r=5 for 5V and r=10 for 10V) | -
| - | out(<n>,<v>[,<sn>]) | -for PHIDGET OUTPUT modules: set analog output channel n to output voltage value v in V (eg. 5.5 for 5.5V) | -
| - | vout(c,v[,sn]) | -for YOCTOPUCE VOLTAGE OUT modules with c the channel (1 or 2),v the voltage as float [0.0-10.0] | -
| - | cout(c[,sn]) | -for YOCTOPUCE CURRENT OUT modules with c the current as float [3.0-21.0] | -
| - | sleep(<float>) | -sleep: add a delay of <float> seconds | -
| S7 Command | -_ | -variable holding the last value read via S7 | -
| - | $ | -variable holding the last state of the button pressed (1 or 0) | -
| - | sleep(<float>) | -sleep: add a delay of <float> seconds | -
| - | button(i,b) | -sets button i to pressed if value b is yes, true, t, or 1, otherwise to normal | -
| - | button(<bool>) | -sets calling button to “pressed” if argument is 1 or True | -
| - | button() | -toggles the state of the button | -
| - | getDBbool(<dbnumber>,<start>,<index>) | -read bool from S7 DB | -
| - | getDBint(<dbnumber>,<start>) | -read int from S7 DB | -
| - | getDBfloat(<dbnumber>,<start>) | -read float from S7 DB | -
| - | setDBbool(<dbnumber>,<start>,<index>,<value>) | -write bool to S7 DB | -
| - | setDBint(<dbnumber>,<start>,<value>) | -write int to S7 DB | -
| - | msetDBint(<dbnumber>,<start>,<andMask>,<orMask>,<value>) | -write value where bits are replaced by those from orMask at positions where andMask bits are not set | -
| - | setDBfloat(<dbnumber>,<start>,<value>) | -write float to S7 DB | -
| Aillio R1 Heater | -- | sets heater to value | -
| Aillio R1 Fan | -- | sets fan to value | -
| Aillio R1 Drum | -- | sets drum speed to value | -
| Aillio R1 Command | -PRS | -Sends PRS command | -
| Artisan Command | -$ | -variable holding the last state of the button pressed (1 or 0) | -
| - | alarms(<bool>) | -enables/disables alarms | -
| - | autoCHARGE(<bool>) | -enables/disables autoCHARGE | -
| - | autoDROP(<bool>) | -enables/disables autoDROP | -
| - | sleep(<float>) | -sleep: add a delay of <float> seconds | -
| - | tare(<int>) | -tare channel <int> with 1 => ET, 2 => BT, 3 => E1c1, 4: E1c2,.. | -
| - | PIDon | -turns PID on | -
| - | PIDoff | -turns PID off | -
| - | PIDtoggle | -toggles the PID state | -
| - | pidmode(<int>) | -sets PID mode to 0: manual, 1: RS, 2: background follow | -
| - | p-i-d(<p>,<i>,<d>) | -sets the p-i-d parameters of the PID | -
| - | adjustSV(<int>) | -increases or decreases the current target SV value by <int> | -
| - | pidSV(<int>) | -sets the PID target set value SV | -
| - | pidSVC(<int>) | -sets the PID target set value SV given in C | -
| - | pidRS(<rs>) | -activates the PID Ramp-Soak pattern number <rs> (1-based!) or the one labeled <rs> | -
| - | pidSource(<int>) | -selects the PID input source with <n> 0: BT, 1: ET (Software PID); <n> in {0,..,3} (Arduino PID) | -
| - | pidLookahead(<int>) | -sets the PID lookahead | -
| - | popup(<msg>[,<int>]) | -shows popup with message <msg> which optionally automatically closes after <int> seconds | -
| - | message(<msg>) | -shows message <msg> in the message line | -
| - | notifications(<bool>) | -enables/disables notifications; while disabled issued notifications are ignored | -
| - | notify(<title>,[<msg>]) | -sends notification with title <title> and optional message <msg> | -
| - | setCanvasColor(<color>) | -sets canvas color to the RGB-hex <color> like #27f1d3 | -
| - | resetCanvasColor | -resets canvas color | -
| - | button(i,b) | -sets button i to pressed if value of b is yes, true, t, or 1, otherwise to normal | -
| - | button(<name>|<bool>) | -activates button <name> from { START, CHARGE, DRY, FCs, FCe, SCs, SCe, DROP, COOL, OFF } ; sets calling button to “pressed” if argument is 1 or True | -
| - | button() | -toggles the state of the button | -
| - | visible(i,b) | -sets button i to visible if value of b is yes, true, t, or 1, otherwise to hidden | -
| - | palette(<p>) | -activates palette <p> with <p> either a number 0-9 or a palette label | -
| - | playbackmode(<int>) | -sets playback mode to 0: off, 1: time, 2: BT, 3: ET | -
| - | openProperties | -opens the Roast Properties dialog | -
| - | loadBackground(<filepath>) | -loads the .alog profile at the given filepath as background profile | -
| - | clearBackground | -clears the current background profile | -
| - | alarmset(<as>) | -activates the alarmset with the given number or label | -
| - | moveBackground(<direction>,<int>) | -moves the background profile the indicated number of steps towards <direction>, with <direction> one of up, down, left, right | -
| - | keyboard(<bool>) | -enables/disables keyboard mode | -
| - | keepON(<bool>) | -enables/disables the Keep ON flag | -
| - | showCurve(<name>,<bool>) | -shows/hides the curve indicated by <name> which is one of { ET, BT, DeltaET, DeltaBT, BackgroundET, BackgroundBT} | -
| - | showExtraCurve(<extra_device>,<curve>,<bool>) | -shows/hides the <curve> (one of {T1,T2}) of the zero-based <extra_device> number | -
| - | showEvents(<event_type>, <bool>) | -shows/hides the events of <event_type> in [1,..,5] | -
| - | showBackgroundEvents(<bool>) | -shows/hides the events of the background profile | -
| RC Command | -pulse(ch,min,max[,sn]) | -for PHIDGET RC modules: sets the min/max pulse width in microseconds | -
| - | pos(ch,min,max[,sn]) | -for PHIDGET RC modules: sets the min/max position | -
| - | engaged(ch,b[,sn]) | -for PHIDGET RC modules: engage (b=1) or disengage (b = 0) | -
| - | ramp(ch,b[,sn]) | -for PHIDGET RC modules: activates or deactivates the speed ramping state | -
| - | volt(ch,v[,sn]) | -for PHIDGET RC modules: set the voltage to one of 5, 6 or 7.4 in Volt | -
| - | accel(ch,a[,sn]) | -for PHIDGET RC modules: set the acceleration | -
| - | veloc(ch,v[,sn]) | -for PHIDGET RC modules: set the velocity | -
| - | set(ch,pos[,sn]) | -for PHIDGET RC modules: set the target position | -
| - | enabled(c,b[,sn]) | -for YOCTOPUCE RC modules: with c:int the channel, b a bool (eg. enabled(0,1) or enabled(0,True)) | -
| - | move(c,p[,t][,sn]) | -for YOCTOPUCE RC modules: with c:int the channel, p:int the target position, the optional t the duration in ms, sn the optional modules serial number or logical name | -
| - | neutral(c,n[,sn]) | -for YOCTOPUCE RC modules: with n an int [0..65000] in us | -
| - | range(c,r[,sn]) | -for YOCTOPUCE RC modules: with r an int in % | -
| WebSocket Command | -$ | -variable holding the last state of the button pressed (1 or 0) | -
| - | send(<json>) | -If {} substitutions are used, json brackets need to be duplicated to escape them like in send({{ “value”: {}}}) | -
| - | sleep(<float>) | -sleep: add a delay of <float> seconds | -
| - | button(i,b) | -sets button i to pressed if value b is yes, true, t, or 1, otherwise to normal | -
| - | button(<bool>) | -sets calling button to “pressed” if argument evaluates to 1 or True | -
| - | button() | -toggles the state of the button | -
| - | read(<json>) | -if the `<json>` text respects the JSON format it is send to the connected WebSocket server and the response is bound to the variable `_` | -
| Button numbers can be drag and dropped to a new position. While holding the ALT key (Windows) / OPTION (macOS) buttons are swapped |
+
| Column | +Description | +
|---|---|
| Button Label | +Enter \n to create labels with multiple lines. \t is substituted by the event type. | +
| Event Description | +Description of the Event to be recorded. | +
| Event Type | +Event type to be recorded or leave blank for no event. '±' types add a chosen offset (positive or negative) to the present value of the chosen event. | +
| Event Value | +Value of event (1-100) to be recorded. | +
| Action | +Perform an action at the time of the event. | +
| Documentation | +The action Command. Depends on the action type, '{}' is replaced by the event value and the offset in case of a ± event type. | +
| Button Visibility | +Hides/shows individual button. | +
| Option | +Description | +
|---|---|
| Max buttons per row | +Sets a maximum number of buttons to display on a single row. | +
| Button size | +Sets a size for the buttons. Choices are tiny, small and large. | +
| Color Pattern | +Applies one of 99 autogenerated color patterns to the buttons. Set to "0" to manually choose the button colors. | +
| Mark Last Pressed | +Invert state and color of last button pressed | +
| Tooltips | +Show button specification as tooltips on hovering a button | +
| Add | +Adds a new button to the bottom of the table. | +
| Insert | +Inserts a new button above the selected button. | +
| Delete | +Deletes the selected button. | +
| Copy Table | +Copy the button table in tab separated format to the clipboard. Option or ALT click to copy a tabular format to the clipboard. | +
| Help | +Opens this window. | +
| The following substitutions are applied to button labels |
+
| String | +Substitution | +
|---|---|
| \n | +New line character | +
| \t | +Event name (translated if using default event names) | +
| \q | +Event type 1 | +
| \w | +Event type 2 | +
| \e | +Event type 3 | +
| \r | +Event type 4 | +
| \0 | +OFF (translated) | +
| \1 | +ON (translated) | +
| \2 | +OFF (translated, respecting button state) | +
| \3 | +ON (translated, respecting button state) | +
| \p | +STOP (translated) | +
| \s | +START (translated) | +
| \P | +STOP (translated, respecting button state) | +
| \S | +START (translated, respecting button state) | +
| \c | +CLOSE (translated) | +
| \o | +OPEN (translated) | +
| \C | +CLOSE (translated, respecting button state) | +
| \O | +OPEN (translated, respecting button state) | +
| \a | +AUTO (translated) | +
| \m | +MANUAL (translated) | +
| \A | +AUTO (translated, respecting button state) | +
| \M | +MANUAL (translated, respecting button state) | +
| \i | +STIRRER | +
| \f | +FILL | +
| \f | +DISCHARGE | +
| \R | +RELEASE | +
| \h | +HEATING | +
| \l | +COOLING | +
| \b | +FLAP | +
| \d | +CONTROL | +
| \V | +event value | +
| \F | +event value interpreted as temperature in Fahrenheit converted to the current temperature mode | +
| \T | +event value interpreted as temperature in Celsius converted to the current temperature mode | +
| Note: "{}" can be used as a placeholder, it will be substituted by the current button value plus the offset for ± event types. If a placeholder occurs several times in a description/command, all those occurrences are replaced by the value. Note: The placeholders {ET}, {BT}, {time}, {ETB}, {BTB}, and {WEIGHTin} will be substituted by the current ET, BT, time, ET background, BT background value, and batch size (in g) in Serial/Artisan/CallProgram/MODBUS/S7/WebSocket commands Note: Commands can be sequenced, separated by semicolons like in “<cmd1>;<cmd2>;<cmd3>” Note: All characters given as documentation to a Serial Command action are sent as one string to the connected device. If the device can interpret this string as separate commands separated by semicolon this is fine. Otherwise you can use a Multiple Event referencing a number of event buttons (using a comma separated list of event button numbers as documentation string) where each of the referenced event buttons issues one of the commands via a corresponding Serial Command action. Those event buttons can be hidden thus having the same effect as if the Serial Command allowed a sequence of commands. Note: In PHIDGET commands, the optional parameter <sn> has the form <hub_serial>[:<hub_port>] allows to refer to a specific Phidget HUB by given its serial number, and optionally specifying the port number the addressed module is connected to. Note: In YOCTOPUCE commands, the optional parameter <sn> holds either the modules serial number or its name |
+
| Action | +Command | +Description | +
|---|---|---|
| Serial Command | +ASCII serial command or binary a2b_uu(serial command) | ++ |
| Call Program | +A program/script path (absolute or relative) | +start an external program | +
| Multiple Event | +button numbers or sleep(<float>) separated by a comma: 1,2,sleep(2.5), 3.. | +triggers other buttons | +
| Modbus Command | +_ | +variable holding the last value read via MODBUS | +
| + | $ | +variable holding the last state of the button pressed (1 or 0) | +
| + | sleep(<float>) | +sleep: add a delay of <float> seconds | +
| + | button(i,b) | +sets button i to pressed if value b is yes, true, t, or 1, otherwise to normal | +
| + | button(<bool>) | +sets calling button to “pressed” if argument is 1 or True | +
| + | button() | +toggles the state of the button | +
| + | read(slaveID,register) | +reads 1 16bit register from slave slaveID using function 3 (Read Multiple Holding Registers) interpreted as unsigned integer. The result is bound to the placeholder `_` and thus can be accessed in later commands. | +
| + | readSigned(slaveId,register) | +reads 1 16bit register from slave slaveID using function 3 (Read Multiple Holding Registers) interpreted as signed integer. The result is bound to the placeholder `_` and thus can be accessed in later commands. | +
| + | readBCD(slaveID,register) | +reads 1 16bit register from slave slaveID using function 3 (Read Multiple Holding Registers) interpreted as BCD. The result is bound to the placeholder `_` and thus can be accessed in later commands. | +
| + | read32(slaveID,register) | +reads 2 16bit registers from slave slaveID using function 3 (Read Multiple Holding Registers) interpreted as unsigned integer. The result is bound to the placeholder `_` and thus can be accessed in later commands. | +
| + | read32Signed(slaveID,register) | +reads 2 16bit registers from slave slaveID using function 3 (Read Multiple Holding Registers) interpreted as signed integer. The result is bound to the placeholder `_` and thus can be accessed in later commands. | +
| + | read32BCD(slaveID,register) | +reads 2 16bit register from slave slaveID using function 3 (Read Multiple Holding Registers) interpreted as BCD. The result is bound to the placeholder `_` and thus can be accessed in later commands. | +
| + | readFloat(slaveID,register) | +reads 2 16bit registers from slave slaveID using function 3 (Read Multiple Holding Registers) interpreted as float. The result is bound to the placeholder `_` and thus can be accessed in later commands. | +
| + | write(slaveId,register,value) or write([slaveId,register,value],..,[slaveId,register,value]) | +write register: MODBUS function 6 (int) or function 16 (float) | +
| + | wcoil(slaveId,register,<bool>) | +write coil: MODBUS function 5 | +
| + | wcoils(slaveId,register,[<bool>,..,<bool>]) | +write coils: MODBUS function 15 | +
| + | mwrite(slaveId,register,andMask,orMask) or mwrite(s,r,am,om,v) | +mask write register: MODBUS function 22 or simulates function 22 with function 6 and the given value v | +
| + | writem(slaveId,register,value) or writem(slaveId,register,[<int>,..,<int>]) | +write registers: MODBUS function 16 | +
| + | writeBCD(s,r,v) or writeBCD([s,r,v],..,[s,r,v]) | +write 16bit BCD encoded value v to register r of slave s | +
| + | writeWord(slaveId,register,value) or writeWord([slaveId,register,value],..,[slaveId,register,value]) | +write 32bit float to two 16bit int registers: MODBUS function 16 | +
| + | writeLong(slaveId,register,value) or writeLong([slaveId,register,value],..,[slaveId,register,value]) | +write 32bit integer to two 16bit int registers: MODBUS function 16 | +
| + | writeSingle(slaveId,register,value) or writeSingle([slaveId,register,value],..,[slaveId,register,value]) | +write 16bit integer to a single 16bit register: MODBUS function 6 (int) | +
| DTA Command | +Insert Data address : value, ex. 4701:1000 and sv is 100. Always multiply with 10 if value Unit: 0.1 / ex. 4719:0 stops heating |
+ + |
| IO Command | +_ | +variable holding the last result value | +
| + | $ | +variable holding the last state of the button pressed (1 or 0) | +
| + | set(c,b[,sn]) | +PHIDGET Binary Output: switches channel c off (b=0) and on (b=1) | +
| + | toggle(c[,sn]) | +PHIDGET Binary Output: toggles channel c | +
| + | pulse(c,t[,sn]) | +PHIDGET Binary Output: sets the output of channel c to on for time t in milliseconds | +
| + | out(c,v[,sn]) | +PHIDGET Voltage Output: sets voltage output of channel c to v (float) | +
| + | accel(c,v[,sn]) | +PHIDGET DCMotor: sets acceleration of channel c to v (float) | +
| + | vel(c,v[,sn]) | +PHIDGET DCMotor: sets target velocity of channel c to v (float) | +
| + | limit(c,v[,sn]) | +PHIDGET DCMotor: sets current limit of channel c to v (float) | +
| + | on(c[,sn]) | +YOCTOPUCE Relay Output: turn channel c of the relay module on | +
| + | off(c[,sn]) | +YOCTOPUCE Relay Output: turn channel c of the relay module off | +
| + | yset(c,b[,sn]) | +YOCTOPUCE Relay Output: switches channel c of the relay module off (b=0) and on (b=1) | +
| + | flip(c[,sn]) | +YOCTOPUCE Relay Output: toggle the state of channel c | +
| + | pip(c,delay,duration[,sn]) | +YOCTOPUCE Relay Output: pulse the channel c on after a delay of delay milliseconds for the duration of duration milliseconds | +
| + | powerReset([sn]) | +YOCTOPUCE resets the power counter of the Yocto-Watt module | +
| + | slider(c,v) | +move slider c to value v | +
| + | button(i,c,b[,sn]) | +switches PHIDGET Binary Output channel c off (b=0) and on (b=1) and sets button i to pressed or normal depending on the value b | +
| + | button(i,b) | +sets button i to pressed if value b is yes, true, t, or 1, otherwise to normal | +
| + | button(b) | +sets button to pressed if value b is yes, true, t, or 1, otherwise to normal | +
| + | button() | +toggles the state of the button | +
| + | sleep(<float>) | +sleep: add a delay of <float> seconds | +
| + | santoker(<target>,<value>) | +sends integer <value> to <target> register specified by as byte in hex notation like “fa” via the Santoker Network protocol | +
| + | kaleido(<target>,<value>) | +sends <value> to <target> via the Kaleido Serial or Network protocol | +
| Hottop Heater | ++ | sets heater to value | +
| Hottop Fan | ++ | sets fan to value | +
| Hottop Command | +motor(n),solenoid(n),stirrer(n),heater(h),fan(f) | +with n={0 ,1},h={0,..100},f={0,..10} | +
| p-i-d | +<p>;<i>;<d> | +configures PID to the values <p>;<i>;<d> | +
| Fuji Command | +write(<unitId>,<register>,<value>) | ++ |
| PWM Command | +out(<channel>,<value>[,<sn>]) | +PHIDGET PWM Output: <value> in [0-100] | +
| + | toggle(<channel>[,<sn>]) | +PHIDGET PWM Output: toggles <channel> | +
| + | pulse(<channel>,<millis>[,<sn>]) | +PHIDGET PWM Output: turn <channel> on for <millis> milliseconds | +
| + | outhub(<channel>,<value>[,<sn>]) | +PHIDGET HUB PWM Output: <value> in [0-100] | +
| + | togglehub(<channel>[,<sn>]) | +PHIDGET HUB PWM Output: toggles <channel> | +
| + | pulsehub(<channel>,<millis>[,<sn>]) | +PHIDGET HUB PWM Output: turn <channel> on for <millis> milliseconds | +
| + | enabled(c,b[,sn]) | +YOCTOPUCE PWM Output: PWM running state | +
| + | freq(c,f[,sn]) | +YOCTOPUCE PWM Output: set PWM frequency to f (Hz) | +
| + | duty(c,d[,sn]) | +YOCTOPUCE PWM Output: set PWM period with the duty cycle in % as a float [0.0-100.0] | +
| + | move(c,d,t[,sn]) | +YOCTOPUCE PWM Output: changes progressively the PWM to the specified value over the given time interval | +
| VOUT Command | +range(c,r[,sn]) | +for PHIDGET OUTPUT modules: sets voltage voltage range (r=5 for 5V and r=10 for 10V) | +
| + | out(<n>,<v>[,<sn>]) | +for PHIDGET OUTPUT modules: set analog output channel n to output voltage value v in V (eg. 5.5 for 5.5V) | +
| + | vout(c,v[,sn]) | +for YOCTOPUCE VOLTAGE OUT modules with c the channel (1 or 2),v the voltage as float [0.0-10.0] | +
| + | cout(c[,sn]) | +for YOCTOPUCE CURRENT OUT modules with c the current as float [3.0-21.0] | +
| + | sleep(<float>) | +sleep: add a delay of <float> seconds | +
| S7 Command | +_ | +variable holding the last value read via S7 | +
| + | $ | +variable holding the last state of the button pressed (1 or 0) | +
| + | sleep(<float>) | +sleep: add a delay of <float> seconds | +
| + | button(i,b) | +sets button i to pressed if value b is yes, true, t, or 1, otherwise to normal | +
| + | button(<bool>) | +sets calling button to “pressed” if argument is 1 or True | +
| + | button() | +toggles the state of the button | +
| + | getDBbool(<dbnumber>,<start>,<index>) | +read bool from S7 DB | +
| + | getDBint(<dbnumber>,<start>) | +read int from S7 DB | +
| + | getDBfloat(<dbnumber>,<start>) | +read float from S7 DB | +
| + | setDBbool(<dbnumber>,<start>,<index>,<value>) | +write bool to S7 DB | +
| + | setDBint(<dbnumber>,<start>,<value>) | +write int to S7 DB | +
| + | msetDBint(<dbnumber>,<start>,<andMask>,<orMask>,<value>) | +write value where bits are replaced by those from orMask at positions where andMask bits are not set | +
| + | setDBfloat(<dbnumber>,<start>,<value>) | +write float to S7 DB | +
| Aillio R1 Heater | ++ | sets heater to value | +
| Aillio R1 Fan | ++ | sets fan to value | +
| Aillio R1 Drum | ++ | sets drum speed to value | +
| Aillio R1 Command | +PRS | +Sends PRS command | +
| Artisan Command | +$ | +variable holding the last state of the button pressed (1 or 0) | +
| + | alarms(<bool>) | +enables/disables alarms | +
| + | autoCHARGE(<bool>) | +enables/disables autoCHARGE | +
| + | autoDROP(<bool>) | +enables/disables autoDROP | +
| + | sleep(<float>) | +sleep: add a delay of <float> seconds | +
| + | tare(<int>) | +tare channel <int> with 1 => ET, 2 => BT, 3 => E1c1, 4: E1c2,.. | +
| + | PIDon | +turns PID on | +
| + | PIDoff | +turns PID off | +
| + | PIDtoggle | +toggles the PID state | +
| + | pidmode(<int>) | +sets PID mode to 0: manual, 1: RS, 2: background follow | +
| + | p-i-d(<p>,<i>,<d>) | +sets the p-i-d parameters of the PID | +
| + | adjustSV(<int>) | +increases or decreases the current target SV value by <int> | +
| + | pidSV(<int>) | +sets the PID target set value SV | +
| + | pidSVC(<int>) | +sets the PID target set value SV given in C | +
| + | pidRS(<rs>) | +activates the PID Ramp-Soak pattern number <rs> (1-based!) or the one labeled <rs> | +
| + | pidSource(<int>) | +selects the PID input source with <n> 0: BT, 1: ET (Software PID); <n> in {0,..,3} (Arduino PID) | +
| + | pidLookahead(<int>) | +sets the PID lookahead | +
| + | popup(<msg>[,<int>]) | +shows popup with message <msg> which optionally automatically closes after <int> seconds | +
| + | message(<msg>) | +shows message <msg> in the message line | +
| + | notifications(<bool>) | +enables/disables notifications; while disabled issued notifications are ignored | +
| + | notify(<title>,[<msg>]) | +sends notification with title <title> and optional message <msg> | +
| + | setCanvasColor(<color>) | +sets canvas color to the RGB-hex <color> like #27f1d3 | +
| + | resetCanvasColor | +resets canvas color | +
| + | button(i,b) | +sets button i to pressed if value of b is yes, true, t, or 1, otherwise to normal | +
| + | button(<name>|<bool>) | +activates button <name> from { START, CHARGE, DRY, FCs, FCe, SCs, SCe, DROP, COOL, OFF } ; sets calling button to “pressed” if argument is 1 or True | +
| + | button() | +toggles the state of the button | +
| + | visible(i,b) | +sets button i to visible if value of b is yes, true, t, or 1, otherwise to hidden | +
| + | palette(<p>) | +activates palette <p> with <p> either a number 0-9 or a palette label | +
| + | playbackmode(<int>) | +sets playback mode to 0: off, 1: time, 2: BT, 3: ET | +
| + | openProperties | +opens the Roast Properties dialog | +
| + | loadBackground(<filepath>) | +loads the .alog profile at the given filepath as background profile | +
| + | clearBackground | +clears the current background profile | +
| + | alarmset(<as>) | +activates the alarmset with the given number or label | +
| + | moveBackground(<direction>,<int>) | +moves the background profile the indicated number of steps towards <direction>, with <direction> one of up, down, left, right | +
| + | keyboard(<bool>) | +enables/disables keyboard mode | +
| + | keepON(<bool>) | +enables/disables the Keep ON flag | +
| + | showCurve(<name>,<bool>) | +shows/hides the curve indicated by <name> which is one of { ET, BT, DeltaET, DeltaBT, BackgroundET, BackgroundBT} | +
| + | showExtraCurve(<extra_device>,<curve>,<bool>) | +shows/hides the <curve> (one of {T1,T2}) of the zero-based <extra_device> number | +
| + | showEvents(<event_type>, <bool>) | +shows/hides the events of <event_type> in [1,..,5] | +
| + | showBackgroundEvents(<bool>) | +shows/hides the events of the background profile | +
| RC Command | +pulse(ch,min,max[,sn]) | +for PHIDGET RC modules: sets the min/max pulse width in microseconds | +
| + | pos(ch,min,max[,sn]) | +for PHIDGET RC modules: sets the min/max position | +
| + | engaged(ch,b[,sn]) | +for PHIDGET RC modules: engage (b=1) or disengage (b = 0) | +
| + | ramp(ch,b[,sn]) | +for PHIDGET RC modules: activates or deactivates the speed ramping state | +
| + | volt(ch,v[,sn]) | +for PHIDGET RC modules: set the voltage to one of 5, 6 or 7.4 in Volt | +
| + | accel(ch,a[,sn]) | +for PHIDGET RC modules: set the acceleration | +
| + | veloc(ch,v[,sn]) | +for PHIDGET RC modules: set the velocity | +
| + | set(ch,pos[,sn]) | +for PHIDGET RC modules: set the target position | +
| + | enabled(c,b[,sn]) | +for YOCTOPUCE RC modules: with c:int the channel, b a bool (eg. enabled(0,1) or enabled(0,True)) | +
| + | move(c,p[,t][,sn]) | +for YOCTOPUCE RC modules: with c:int the channel, p:int the target position, the optional t the duration in ms, sn the optional modules serial number or logical name | +
| + | neutral(c,n[,sn]) | +for YOCTOPUCE RC modules: with n an int [0..65000] in us | +
| + | range(c,r[,sn]) | +for YOCTOPUCE RC modules: with r an int in % | +
| WebSocket Command | +$ | +variable holding the last state of the button pressed (1 or 0) | +
| + | send(<json>) | +If {} substitutions are used, json brackets need to be duplicated to escape them like in send({{ “value”: {}}}) | +
| + | sleep(<float>) | +sleep: add a delay of <float> seconds | +
| + | button(i,b) | +sets button i to pressed if value b is yes, true, t, or 1, otherwise to normal | +
| + | button(<bool>) | +sets calling button to “pressed” if argument evaluates to 1 or True | +
| + | button() | +toggles the state of the button | +
| + | read(<json>) | +if the `<json>` text respects the JSON format it is send to the connected WebSocket server and the response is bound to the variable `_` | +
| Column | -Description | -
|---|---|
| Event | -Hide or show the corresponding slider. | -
| Action | -Perform an action on the slider release. | -
| Command | -Command to perform, depends on the Action type. ('{}' is replaced by the slider value*Factor + Offset) | -
| Offset | -Offset to be added to the Slider value (after scaling by Factor). | -
| Factor | -Scale factor, Slider value is multiplied by this value. | -
| Min | -Sets the minimum value for the range of the slider. | -
| Max | -Sets the maximum value for the range of the slider. | -
| Course | -When ticked the slider moves in steps of 10. | -
| Temp | -Should be ticked when the slider's value is a temperature to allow Artisan to properly scale the value between Centigrade and Fahrenheit. | -
| Unit | -Optional text used in annotations to the the units used for the slider value. | -
| Note: "{}" can be used as a placeholder, it will be substituted by (value*factor + offset). In all slider command actions, but for IO, VOUT, S7 and RC Commands, the bound value is converted from a float to an int. Note: The placeholders {ET}, {BT}, {time}, {ETB}, {BTB}, and {WEIGHTin} will be substituted by the current ET, BT, time, ET background, BT background value, and batch size (in g) in Serial/Artisan/CallProgram/MODBUS/S7/WebSocket commands Note: commands can be sequenced, separated by semicolons like in “<cmd1>;<cmd2>;<cmd3>” Note: in PHIDGET commands, the optional parameter <sn> has the form <hub_serial>[:<hub_port>] allows to refer to a specific Phidget HUB by given its serial number, and optionally specifying the port number the addressed module is connected to. Note: in YOCTOPUCE commands, the optional parameters <sn> holds either the modules serial number or its name |
-
| Action | -Command | -Description | -
|---|---|---|
| Serial Command | -ASCII serial command or binary a2b_uu(serial command) | -- |
| Modbus Command | -_ | -variable holding the last value read via MODBUS | -
| - | sleep(<float>) | -sleep: add a delay of <float> seconds | -
| - | button(<bool>) | -sets calling button to “pressed” if argument is 1 or True | -
| - | read(slaveID,register) | -reads register from slave slaveID using function 3 (Read Multiple Holding Registers). The result is bound to the placeholder `_` and thus can be accessed in later commands. | -
| - | readSigned(slaveId,register) | -reads 1 16bit register from slave slaveID using function 3 (Read Multiple Holding Registers) interpreted as signed integer. The result is bound to the placeholder `_` and thus can be accessed in later commands. | -
| - | readBCD(slaveID,register) | -reads 1 16bit register from slave slaveID using function 3 (Read Multiple Holding Registers) interpreted as BCD. The result is bound to the placeholder `_` and thus can be accessed in later commands. | -
| - | read32(slaveID,register) | -reads 2 16bit registers from slave slaveID using function 3 (Read Multiple Holding Registers) interpreted as unsigned integer. The result is bound to the placeholder `_` and thus can be accessed in later commands. | -
| - | read32Signed(slaveID,register) | -reads 2 16bit registers from slave slaveID using function 3 (Read Multiple Holding Registers) interpreted as signed integer. The result is bound to the placeholder `_` and thus can be accessed in later commands. | -
| - | read32BCD(slaveID,register) | -reads 2 16bit register from slave slaveID using function 3 (Read Multiple Holding Registers) interpreted as BCD. The result is bound to the placeholder `_` and thus can be accessed in later commands. | -
| - | readFloat(slaveID,register) | -reads 2 16bit registers from slave slaveID using function 3 (Read Multiple Holding Registers) interpreted as float. The result is bound to the placeholder `_` and thus can be accessed in later commands. | -
| - | write(slaveId,register,value) or write([slaveId,register,value],..,[slaveId,register,value]) | -write register: MODBUS function 6 (int) or function 16 (float) | -
| - | wcoil(slaveId,register,<bool>) | -write coil: MODBUS function 5 | -
| - | wcoils(slaveId,register,[<bool>,..,<bool>]) | -write coils: MODBUS function 15 | -
| - | mwrite(slaveId,register,andMask,orMask) or mwrite(s,r,am,om,v) | -mask write register: MODBUS function 22 or simulates function 22 with function 6 and the given value v | -
| - | writem(slaveId,register,value) or writem(slaveId,register,[<int>,..,<int>]) | -write registers: MODBUS function 16 | -
| - | writeBCD(s,r,v) or writeBCD([s,r,v],..,[s,r,v]) | -write 16bit BCD encoded value v to register r of slave s | -
| - | writeWord(slaveId,register,value) or writeWord([slaveId,register,value],..,[slaveId,register,value]) | -write 32bit float to two 16bit int registers: MODBUS function 16 | -
| - | writeLong(slaveId,register,value) or writeLong([slaveId,register,value],..,[slaveId,register,value]) | -write 32bit integer to two 16bit int registers: MODBUS function 16 | -
| - | writeSingle(slaveId,register,value) or writeSingle([slaveId,register,value],..,[slaveId,register,value]) | -write 16bit integer to a single 16bit register: MODBUS function 6 (int) | -
| DTA Command | -Insert Data address : value, ex. 4701:1000 and sv is 100. | -Always multiply with 10 if value Unit: 0.1 / ex. 4719:0 stops heating | -
| Call Program | -A program/script path (absolute or relative) | -start and external program | -
| Hottop Heater | -- | sets heater to value | -
| Hottop Fan | -- | sets fan to value | -
| Hottop Command | -motor(n),solenoid(n),stirrer(n),heater(h),fan(f) | -with n={0 ,1},h={0,..100},f={0,..10} | -
| Fuji Command | -write(<unitId>,<register>,<value>) | -- |
| PWM Command | -out(<channel>,<value>[,<sn>]) | -PHIDGET PWM Output: <value> in [0-100] | -
| - | toggle(<channel>[,<sn>]) | -PHIDGET PWM Output: toggles <channel> | -
| - | pulse(<channel>,<millis>[,<sn>]) | -PHIDGET PWM Output: turn <channel> on for <millis> milliseconds | -
| - | outhub(<channel>,<value>[,<sn>]) | -PHIDGET HUB PWM Output: <value> in [0-100] | -
| - | togglehub(<channel>[,<sn>]) | -PHIDGET HUB PWM Output: toggles <channel> | -
| - | pulsehub(<channel>,<millis>[,<sn>]) | -PHIDGET HUB PWM Output: turn <channel> on for <millis> milliseconds | -
| - | enabled(c,b[,sn]) | -YOCTOPUCE PWM Output: PWM running state | -
| - | freq(c,f[,sn]) | -YOCTOPUCE PWM Output: set PWM frequency to f (Hz) | -
| - | duty(c,d[,sn]) | -YOCTOPUCE PWM Output: set PWM period with the duty cycle in % as a float [0.0-100.0] | -
| - | move(c,d,t[,sn]) | -YOCTOPUCE PWM Output: changes progressively the PWM to the specified value over the given time interval | -
| VOUT Command | -range(c,r[,sn]) | -for PHIDGET OUTPUT modules: sets voltage voltage range (r=5 for r5V and r=10 for 10V) | -
| - | out(n,v[,sn]) | -for PHIDGET OUTPUT modules: set analog output channel n to output voltage value v in V (eg. 5.5 for 5.5V) | -
| - | vout(c,v[,sn]) | -for YOCTOPUCE VOLTAGE OUT modules with c the channel (1 or 2),v the voltage as float [0.0-10.0] | -
| - | cout(c[,sn]) | -for YOCTOPUCE CURRENT OUT modules with c the current as float [3.0-21.0] | -
| - | sleep(<float>) | -sleep: add a delay of <float> seconds | -
| IO Command | -set(c,b[,sn]) | -PHIDGET Binary Output: switches channel c off (b=0) and on (b=1) | -
| - | toggle(c[,sn]) | -PHIDGET Binary Output: toggles channel c | -
| - | pulse(c,t[,sn]) | -PHIDGET Binary Output: sets the output of channel c to on for time t in milliseconds | -
| - | out(c,v[,sn]) | -PHIDGET Voltage Output: sets voltage output of channel c to v (float) | -
| - | accel(c,v[,sn]) | -PHIDGET DCMotor: sets acceleration of channel c to v (float) | -
| - | vel(c,v[,sn]) | -PHIDGET DCMotor: sets target velocity of channel c to v (float) | -
| - | limit(c,v[,sn]) | -PHIDGET DCMotor: sets current limit of channel c to v (float) | -
| - | on(c[,sn]) | -YOCTOPUCE Relay Output: turn channel c of the relay module on | -
| - | off(c[,sn]) | -YOCTOPUCE Relay Output: turn channel c of the relay module off | -
| - | yset(c,b[,sn]) | -YOCTOPUCE Relay Output: switches channel c of the relay module off (b=0) and on (b=1) | -
| - | flip(c[,sn]) | -YOCTOPUCE Relay Output: toggle the state of channel c | -
| - | pip(c,delay,duration[,sn]) | -YOCTOPUCE Relay Output: pulse the channel c on after a delay of delay milliseconds for the duration of duration milliseconds | -
| - | powerReset([sn]) | -YOCTOPUCE resets the power counter of the Yocto-Watt module | -
| - | slider(c,v) | -move slider c to value v | -
| - | button(i,c,b[,sn]) | -switches PHIDGET Binary Output channel c off (b=0) and on (b=1) and sets button i to pressed or normal depending on the value b | -
| - | button(i,b) | -sets button i to pressed if value b is yes, true, t, or 1, otherwise to normal | -
| - | button(b) | -sets button to pressed if value b is yes, true, t, or 1, otherwise to normal | -
| - | button() | -toggles the state of the button | -
| - | sleep(<float>) | -sleep: add a delay of <float> seconds | -
| - | santoker(<target>,<value>) | -sends integer <value> to <target> register specified by as byte in hex notation like “fa” via the Santoker Network protocol | -
| - | kaleido(<target>,<value>) | -sends <value> to <target> via the Kaleido Serial or Network protocol | -
| S7 Command | -_ | -variable holding the last value read via S7 | -
| - | sleep(<float>) | -sleep: add a delay of <float> seconds | -
| - | button(<bool>) | -sets calling button to “pressed” if argument evaluates to 1 or True | -
| - | getDBbool(<dbnumber>,<start>,<index>) | -read bool from S7 DB | -
| - | getDBint(<dbnumber>,<start>) | -read int from S7 DB | -
| - | getDBfloat(<dbnumber>,<start>) | -read float from S7 DB | -
| - | setDBbool(<dbnumber>,<start>,<index>,<value>) | -write bool to S7 DB | -
| - | setDBint(<dbnumber>,<start>,<value>) | -write int to S7 DB | -
| - | setDBfloat(<dbnumber>,<start>,<value>) | -write float to S7 DB | -
| Aillio R1 Heater | -- | sets heater to value | -
| Aillio R1 Fan | -- | sets fan to value | -
| Aillio R1 Drum | -- | sets drum speed to value | -
| Artisan Command | -alarms(<bool>) | -enables/disables alarms | -
| - | autoCHARGE(<bool>) | -enables/disables autoCHARGE | -
| - | autoDROP(<bool>) | -enables/disables autoDROP | -
| - | sleep(<float>) | -sleep: add a delay of <float> seconds | -
| - | tare(<int>) | -tare channel <int> with 1 => ET, 2 => BT, 3 => E1c1, 4: E1c2,.. | -
| - | PIDon | -turns PID on | -
| - | PIDoff | -turns PID off | -
| - | PIDtoggle | -toggles the PID state | -
| - | pidmode(<int>) | -sets PID mode to 0: manual, 1: RS, 2: background follow | -
| - | p-i-d(<p>,<i>,<d>) | -sets the p-i-d parameters of the PID | -
| - | adjustSV(<int>) | -increases or decreases the current target SV value by <int> | -
| - | pidSV(<int>) | -sets the PID target set value SV | -
| - | pidSVC(<int>) | -sets the PID target set value SV given in C | -
| - | pidRS(<rs>) | -activates the PID Ramp-Soak pattern number <rs> (1-based!) or the one labeled <rs> | -
| - | pidSource(<int>) | -selects the PID input source with <n> 0: BT, 1: ET (Software PID); <n> in {0,..,3} (Arduino PID) | -
| - | pidLookahead(<int>) | -sets the PID lookahead | -
| - | popup(<msg>[,<int>]) | -shows popup with message <msg> which optionally automatically closes after <int> seconds | -
| - | message(<msg>) | -shows message <msg> in the message line | -
| - | notifications(<bool>) | -enables/disables notifications; while disabled issued notifications are ignored | -
| - | notify(<title>,[<msg>]) | -sends notification with title <title> and optional message <msg> | -
| - | setCanvasColor(<color>) | -sets canvas color to the RGB-hex <color> like #27f1d3 | -
| - | resetCanvasColor | -resets canvas color | -
| - | button(<name>) | -activates button <name> from { START, CHARGE, DRY, FCs, FCe, SCs, SCe, DROP, COOL, OFF } | -
| - | palette(<p>) | -activates palette <p> with <p> either a number 0-9 or a palette label | -
| - | playbackmode(<int>) | -sets playback mode to 0: off, 1: time, 2: BT, 3: ET | -
| - | openProperties | -opens the Roast Properties dialog | -
| - | loadBackground(<filepath>) | -loads the .alog profile at the given filepath as background profile | -
| - | clearBackground | -clears the current background profile | -
| - | alarmset(<as>) | -activates the alarmset with the given number or label | -
| - | moveBackground(<direction>,<int>) | -moves the background profile the indicated number of steps towards <direction>, with <direction> one of up, down, left, right | -
| - | keyboard(<bool>) | -enables/disables keyboard mode | -
| - | keepON(<bool>) | -enables/disables the Keep ON flag | -
| - | showCurve(<name>,<bool>) | -shows/hides the curve indicated by <name> which is one of { ET, BT, DeltaET, DeltaBT, BackgroundET, BackgroundBT} | -
| - | showExtraCurve(<extra_device>,<curve>,<bool>) | -shows/hides the <curve> (one of {T1,T2}) of the zero-based <extra_device> number | -
| - | showEvents(<event_type>, <bool>) | -shows/hides the events of <event_type> in [1,..,5] | -
| - | showBackgroundEvents(<bool>) | -shows/hides the events of the background profile | -
| RC Command | -pulse(ch,min,max[,sn]) | -for PHIDGET RC modules: sets the min/max pulse width in microseconds | -
| - | pos(ch,min,max[,sn]) | -for PHIDGET RC modules: sets the min/max position | -
| - | engaged(ch,b[,sn]) | -for PHIDGET RC modules: engage (b=1) or disengage (b = 0) | -
| - | ramp(ch,b[,sn]) | -for PHIDGET RC modules: activates or deactivates the speed ramping state | -
| - | volt(ch,v[,sn]) | -for PHIDGET RC modules: set the voltage to one of 5, 6 or 7.4 in Volt | -
| - | accel(ch,a[,sn]) | -for PHIDGET RC modules: set the acceleration | -
| - | veloc(ch,v[,sn]) | -for PHIDGET RC modules: set the velocity | -
| - | set(ch,pos[,sn]) | -for PHIDGET RC modules: set the target position | -
| - | enabled(c,b[,sn]) | -for YOCTOPUCE RC modules: with c:int the channel, b a bool (eg. enabled(0,1) or enabled(0,True)) | -
| - | move(c,p[,t][,sn]) | -for YOCTOPUCE RC modules: with c:int the channel, p:int the target position, the optional t the duration in ms | -
| - | neutral(c,n[,sn]) | -for YOCTOPUCE RC modules: with n an int [0..65000] in us | -
| - | range(c,r[,sn]) | -for YOCTOPUCE RC modules: with r an int in % | -
| WebSocket Command | -send(<json>) | -If {} substitutions are used, json brackets need to be duplicated to escape them like in send({{ “value”: {}}}) | -
| - | sleep(<float>) | -sleep: add a delay of <float> seconds | -
| - | button(<bool>) | -sets calling button to “pressed” if argument evaluates to 1 or True | -
| - | read(<json>) | -if the `<json>` text respects the JSON format it is send to the connected WebSocket server and the response is bound to the variable `_` | -
| Column | +Description | +
|---|---|
| Event | +Hide or show the corresponding slider. | +
| Action | +Perform an action on the slider release. | +
| Command | +Command to perform, depends on the Action type. ('{}' is replaced by the slider value*Factor + Offset) | +
| Offset | +Offset to be added to the Slider value (after scaling by Factor). | +
| Factor | +Scale factor, Slider value is multiplied by this value. | +
| Min | +Sets the minimum value for the range of the slider. | +
| Max | +Sets the maximum value for the range of the slider. | +
| Course | +When ticked the slider moves in steps of 10. | +
| Temp | +Should be ticked when the slider's value is a temperature to allow Artisan to properly scale the value between Centigrade and Fahrenheit. | +
| Unit | +Optional text used in annotations to the the units used for the slider value. | +
| Note: "{}" can be used as a placeholder, it will be substituted by (value*factor + offset). In all slider command actions, but for IO, VOUT, S7 and RC Commands, the bound value is converted from a float to an int. Note: The placeholders {ET}, {BT}, {time}, {ETB}, {BTB}, and {WEIGHTin} will be substituted by the current ET, BT, time, ET background, BT background value, and batch size (in g) in Serial/Artisan/CallProgram/MODBUS/S7/WebSocket commands Note: commands can be sequenced, separated by semicolons like in “<cmd1>;<cmd2>;<cmd3>” Note: in PHIDGET commands, the optional parameter <sn> has the form <hub_serial>[:<hub_port>] allows to refer to a specific Phidget HUB by given its serial number, and optionally specifying the port number the addressed module is connected to. Note: in YOCTOPUCE commands, the optional parameters <sn> holds either the modules serial number or its name |
+
| Action | +Command | +Description | +
|---|---|---|
| Serial Command | +ASCII serial command or binary a2b_uu(serial command) | ++ |
| Modbus Command | +_ | +variable holding the last value read via MODBUS | +
| + | sleep(<float>) | +sleep: add a delay of <float> seconds | +
| + | button(<bool>) | +sets calling button to “pressed” if argument is 1 or True | +
| + | read(slaveID,register) | +reads register from slave slaveID using function 3 (Read Multiple Holding Registers). The result is bound to the placeholder `_` and thus can be accessed in later commands. | +
| + | readSigned(slaveId,register) | +reads 1 16bit register from slave slaveID using function 3 (Read Multiple Holding Registers) interpreted as signed integer. The result is bound to the placeholder `_` and thus can be accessed in later commands. | +
| + | readBCD(slaveID,register) | +reads 1 16bit register from slave slaveID using function 3 (Read Multiple Holding Registers) interpreted as BCD. The result is bound to the placeholder `_` and thus can be accessed in later commands. | +
| + | read32(slaveID,register) | +reads 2 16bit registers from slave slaveID using function 3 (Read Multiple Holding Registers) interpreted as unsigned integer. The result is bound to the placeholder `_` and thus can be accessed in later commands. | +
| + | read32Signed(slaveID,register) | +reads 2 16bit registers from slave slaveID using function 3 (Read Multiple Holding Registers) interpreted as signed integer. The result is bound to the placeholder `_` and thus can be accessed in later commands. | +
| + | read32BCD(slaveID,register) | +reads 2 16bit register from slave slaveID using function 3 (Read Multiple Holding Registers) interpreted as BCD. The result is bound to the placeholder `_` and thus can be accessed in later commands. | +
| + | readFloat(slaveID,register) | +reads 2 16bit registers from slave slaveID using function 3 (Read Multiple Holding Registers) interpreted as float. The result is bound to the placeholder `_` and thus can be accessed in later commands. | +
| + | write(slaveId,register,value) or write([slaveId,register,value],..,[slaveId,register,value]) | +write register: MODBUS function 6 (int) or function 16 (float) | +
| + | wcoil(slaveId,register,<bool>) | +write coil: MODBUS function 5 | +
| + | wcoils(slaveId,register,[<bool>,..,<bool>]) | +write coils: MODBUS function 15 | +
| + | mwrite(slaveId,register,andMask,orMask) or mwrite(s,r,am,om,v) | +mask write register: MODBUS function 22 or simulates function 22 with function 6 and the given value v | +
| + | writem(slaveId,register,value) or writem(slaveId,register,[<int>,..,<int>]) | +write registers: MODBUS function 16 | +
| + | writeBCD(s,r,v) or writeBCD([s,r,v],..,[s,r,v]) | +write 16bit BCD encoded value v to register r of slave s | +
| + | writeWord(slaveId,register,value) or writeWord([slaveId,register,value],..,[slaveId,register,value]) | +write 32bit float to two 16bit int registers: MODBUS function 16 | +
| + | writeLong(slaveId,register,value) or writeLong([slaveId,register,value],..,[slaveId,register,value]) | +write 32bit integer to two 16bit int registers: MODBUS function 16 | +
| + | writeSingle(slaveId,register,value) or writeSingle([slaveId,register,value],..,[slaveId,register,value]) | +write 16bit integer to a single 16bit register: MODBUS function 6 (int) | +
| DTA Command | +Insert Data address : value, ex. 4701:1000 and sv is 100. | +Always multiply with 10 if value Unit: 0.1 / ex. 4719:0 stops heating | +
| Call Program | +A program/script path (absolute or relative) | +start and external program | +
| Hottop Heater | ++ | sets heater to value | +
| Hottop Fan | ++ | sets fan to value | +
| Hottop Command | +motor(n),solenoid(n),stirrer(n),heater(h),fan(f) | +with n={0 ,1},h={0,..100},f={0,..10} | +
| Fuji Command | +write(<unitId>,<register>,<value>) | ++ |
| PWM Command | +out(<channel>,<value>[,<sn>]) | +PHIDGET PWM Output: <value> in [0-100] | +
| + | toggle(<channel>[,<sn>]) | +PHIDGET PWM Output: toggles <channel> | +
| + | pulse(<channel>,<millis>[,<sn>]) | +PHIDGET PWM Output: turn <channel> on for <millis> milliseconds | +
| + | outhub(<channel>,<value>[,<sn>]) | +PHIDGET HUB PWM Output: <value> in [0-100] | +
| + | togglehub(<channel>[,<sn>]) | +PHIDGET HUB PWM Output: toggles <channel> | +
| + | pulsehub(<channel>,<millis>[,<sn>]) | +PHIDGET HUB PWM Output: turn <channel> on for <millis> milliseconds | +
| + | enabled(c,b[,sn]) | +YOCTOPUCE PWM Output: PWM running state | +
| + | freq(c,f[,sn]) | +YOCTOPUCE PWM Output: set PWM frequency to f (Hz) | +
| + | duty(c,d[,sn]) | +YOCTOPUCE PWM Output: set PWM period with the duty cycle in % as a float [0.0-100.0] | +
| + | move(c,d,t[,sn]) | +YOCTOPUCE PWM Output: changes progressively the PWM to the specified value over the given time interval | +
| VOUT Command | +range(c,r[,sn]) | +for PHIDGET OUTPUT modules: sets voltage voltage range (r=5 for r5V and r=10 for 10V) | +
| + | out(n,v[,sn]) | +for PHIDGET OUTPUT modules: set analog output channel n to output voltage value v in V (eg. 5.5 for 5.5V) | +
| + | vout(c,v[,sn]) | +for YOCTOPUCE VOLTAGE OUT modules with c the channel (1 or 2),v the voltage as float [0.0-10.0] | +
| + | cout(c[,sn]) | +for YOCTOPUCE CURRENT OUT modules with c the current as float [3.0-21.0] | +
| + | sleep(<float>) | +sleep: add a delay of <float> seconds | +
| IO Command | +set(c,b[,sn]) | +PHIDGET Binary Output: switches channel c off (b=0) and on (b=1) | +
| + | toggle(c[,sn]) | +PHIDGET Binary Output: toggles channel c | +
| + | pulse(c,t[,sn]) | +PHIDGET Binary Output: sets the output of channel c to on for time t in milliseconds | +
| + | out(c,v[,sn]) | +PHIDGET Voltage Output: sets voltage output of channel c to v (float) | +
| + | accel(c,v[,sn]) | +PHIDGET DCMotor: sets acceleration of channel c to v (float) | +
| + | vel(c,v[,sn]) | +PHIDGET DCMotor: sets target velocity of channel c to v (float) | +
| + | limit(c,v[,sn]) | +PHIDGET DCMotor: sets current limit of channel c to v (float) | +
| + | on(c[,sn]) | +YOCTOPUCE Relay Output: turn channel c of the relay module on | +
| + | off(c[,sn]) | +YOCTOPUCE Relay Output: turn channel c of the relay module off | +
| + | yset(c,b[,sn]) | +YOCTOPUCE Relay Output: switches channel c of the relay module off (b=0) and on (b=1) | +
| + | flip(c[,sn]) | +YOCTOPUCE Relay Output: toggle the state of channel c | +
| + | pip(c,delay,duration[,sn]) | +YOCTOPUCE Relay Output: pulse the channel c on after a delay of delay milliseconds for the duration of duration milliseconds | +
| + | powerReset([sn]) | +YOCTOPUCE resets the power counter of the Yocto-Watt module | +
| + | slider(c,v) | +move slider c to value v | +
| + | button(i,c,b[,sn]) | +switches PHIDGET Binary Output channel c off (b=0) and on (b=1) and sets button i to pressed or normal depending on the value b | +
| + | button(i,b) | +sets button i to pressed if value b is yes, true, t, or 1, otherwise to normal | +
| + | button(b) | +sets button to pressed if value b is yes, true, t, or 1, otherwise to normal | +
| + | button() | +toggles the state of the button | +
| + | sleep(<float>) | +sleep: add a delay of <float> seconds | +
| + | santoker(<target>,<value>) | +sends integer <value> to <target> register specified by as byte in hex notation like “fa” via the Santoker Network protocol | +
| + | kaleido(<target>,<value>) | +sends <value> to <target> via the Kaleido Serial or Network protocol | +
| S7 Command | +_ | +variable holding the last value read via S7 | +
| + | sleep(<float>) | +sleep: add a delay of <float> seconds | +
| + | button(<bool>) | +sets calling button to “pressed” if argument evaluates to 1 or True | +
| + | getDBbool(<dbnumber>,<start>,<index>) | +read bool from S7 DB | +
| + | getDBint(<dbnumber>,<start>) | +read int from S7 DB | +
| + | getDBfloat(<dbnumber>,<start>) | +read float from S7 DB | +
| + | setDBbool(<dbnumber>,<start>,<index>,<value>) | +write bool to S7 DB | +
| + | setDBint(<dbnumber>,<start>,<value>) | +write int to S7 DB | +
| + | setDBfloat(<dbnumber>,<start>,<value>) | +write float to S7 DB | +
| Aillio R1 Heater | ++ | sets heater to value | +
| Aillio R1 Fan | ++ | sets fan to value | +
| Aillio R1 Drum | ++ | sets drum speed to value | +
| Artisan Command | +alarms(<bool>) | +enables/disables alarms | +
| + | autoCHARGE(<bool>) | +enables/disables autoCHARGE | +
| + | autoDROP(<bool>) | +enables/disables autoDROP | +
| + | sleep(<float>) | +sleep: add a delay of <float> seconds | +
| + | tare(<int>) | +tare channel <int> with 1 => ET, 2 => BT, 3 => E1c1, 4: E1c2,.. | +
| + | PIDon | +turns PID on | +
| + | PIDoff | +turns PID off | +
| + | PIDtoggle | +toggles the PID state | +
| + | pidmode(<int>) | +sets PID mode to 0: manual, 1: RS, 2: background follow | +
| + | p-i-d(<p>,<i>,<d>) | +sets the p-i-d parameters of the PID | +
| + | adjustSV(<int>) | +increases or decreases the current target SV value by <int> | +
| + | pidSV(<int>) | +sets the PID target set value SV | +
| + | pidSVC(<int>) | +sets the PID target set value SV given in C | +
| + | pidRS(<rs>) | +activates the PID Ramp-Soak pattern number <rs> (1-based!) or the one labeled <rs> | +
| + | pidSource(<int>) | +selects the PID input source with <n> 0: BT, 1: ET (Software PID); <n> in {0,..,3} (Arduino PID) | +
| + | pidLookahead(<int>) | +sets the PID lookahead | +
| + | popup(<msg>[,<int>]) | +shows popup with message <msg> which optionally automatically closes after <int> seconds | +
| + | message(<msg>) | +shows message <msg> in the message line | +
| + | notifications(<bool>) | +enables/disables notifications; while disabled issued notifications are ignored | +
| + | notify(<title>,[<msg>]) | +sends notification with title <title> and optional message <msg> | +
| + | setCanvasColor(<color>) | +sets canvas color to the RGB-hex <color> like #27f1d3 | +
| + | resetCanvasColor | +resets canvas color | +
| + | button(<name>) | +activates button <name> from { START, CHARGE, DRY, FCs, FCe, SCs, SCe, DROP, COOL, OFF } | +
| + | palette(<p>) | +activates palette <p> with <p> either a number 0-9 or a palette label | +
| + | playbackmode(<int>) | +sets playback mode to 0: off, 1: time, 2: BT, 3: ET | +
| + | openProperties | +opens the Roast Properties dialog | +
| + | loadBackground(<filepath>) | +loads the .alog profile at the given filepath as background profile | +
| + | clearBackground | +clears the current background profile | +
| + | alarmset(<as>) | +activates the alarmset with the given number or label | +
| + | moveBackground(<direction>,<int>) | +moves the background profile the indicated number of steps towards <direction>, with <direction> one of up, down, left, right | +
| + | keyboard(<bool>) | +enables/disables keyboard mode | +
| + | keepON(<bool>) | +enables/disables the Keep ON flag | +
| + | showCurve(<name>,<bool>) | +shows/hides the curve indicated by <name> which is one of { ET, BT, DeltaET, DeltaBT, BackgroundET, BackgroundBT} | +
| + | showExtraCurve(<extra_device>,<curve>,<bool>) | +shows/hides the <curve> (one of {T1,T2}) of the zero-based <extra_device> number | +
| + | showEvents(<event_type>, <bool>) | +shows/hides the events of <event_type> in [1,..,5] | +
| + | showBackgroundEvents(<bool>) | +shows/hides the events of the background profile | +
| RC Command | +pulse(ch,min,max[,sn]) | +for PHIDGET RC modules: sets the min/max pulse width in microseconds | +
| + | pos(ch,min,max[,sn]) | +for PHIDGET RC modules: sets the min/max position | +
| + | engaged(ch,b[,sn]) | +for PHIDGET RC modules: engage (b=1) or disengage (b = 0) | +
| + | ramp(ch,b[,sn]) | +for PHIDGET RC modules: activates or deactivates the speed ramping state | +
| + | volt(ch,v[,sn]) | +for PHIDGET RC modules: set the voltage to one of 5, 6 or 7.4 in Volt | +
| + | accel(ch,a[,sn]) | +for PHIDGET RC modules: set the acceleration | +
| + | veloc(ch,v[,sn]) | +for PHIDGET RC modules: set the velocity | +
| + | set(ch,pos[,sn]) | +for PHIDGET RC modules: set the target position | +
| + | enabled(c,b[,sn]) | +for YOCTOPUCE RC modules: with c:int the channel, b a bool (eg. enabled(0,1) or enabled(0,True)) | +
| + | move(c,p[,t][,sn]) | +for YOCTOPUCE RC modules: with c:int the channel, p:int the target position, the optional t the duration in ms | +
| + | neutral(c,n[,sn]) | +for YOCTOPUCE RC modules: with n an int [0..65000] in us | +
| + | range(c,r[,sn]) | +for YOCTOPUCE RC modules: with r an int in % | +
| WebSocket Command | +send(<json>) | +If {} substitutions are used, json brackets need to be duplicated to escape them like in send({{ “value”: {}}}) | +
| + | sleep(<float>) | +sleep: add a delay of <float> seconds | +
| + | button(<bool>) | +sets calling button to “pressed” if argument evaluates to 1 or True | +
| + | read(<json>) | +if the `<json>` text respects the JSON format it is send to the connected WebSocket server and the response is bound to the variable `_` | +
| Keys | -Description | -
|---|---|
| ENTER | -Turns ON/OFF Keyboard Shortcuts | -
| ⌘-ENTER [Mac] CTRL+ENTER [Win] |
- Starts recording | -
| SHIFT-ENTER | -Turns Artisan OFF | -
| SPACE | -When Keyboard Shortcuts are ON chooses the current button When Keyboard Shortcuts are OFF adds a custom event When Meter=NONE opens dialog to manually enter temperatures during roast |
-
| LEFT,RIGHT | -Change roast event key focus | -
| LEFT,RIGHT,UP,DOWN | -Move background (when sliders not visible or when Config>> Events>> Sliders tab>> Keyboard Control is not selected) | -
| A | -Autosave | -
| ⌘-N [Mac] CRTL+N [Win] |
- Autosave + RESET + START | -
| T [Mac] CTRL+SHIFT+T [Win] |
- Toggle mouse cross lines | -
| G | -Toggle auto axis mode between Roast, BBP+Roast and BBP | -
| D | -Toggle xy cursor mode (off/temp/delta) | -
| Z | -Toggle xy cursor clamp mode (off/BT/ET/BTB/ETB) | -
| U | -Toggle LCD cursor (off/profile/background) | -
| C | -Shows/Hides Controls | -
| X | -Shows/Hides LCD Readings | -
| Y | -Shows/Hides Mini Event editor (on recording) | -
| M | -Shows/Hides Event Buttons | -
| B | -Shows/Hides Extra Event Buttons | -
| S | -Shows/Hides Event Sliders | -
| P | -Toggle PID mode | -
| J | -Toggle Playback Events | -
| H CTRL+H [Win] |
- Load background profile | -
| OPTION+H [Mac] CTRL+SHIFT+H [Win] |
- Remove background profile | -
| I | -Toggle foreground curves “show full” | -
| O | -Toggle background curves “show full” | -
| L | -Load alarms | -
| +,- | -Inc/dec PID lookahead | -
| ⌘ +,- [Mac] CRTL +,- [Win] |
- Inc/dec graph resolution | -
| ⌘ 0-9 [Mac] CRTL 0-9 [Win] |
- Changes Event Button Palettes | -
| ; | -Application ScreenShot | -
| : | -Desktop ScreenShot | -
| Q,W,E,R + <value> | -Quick Special Event Entry. The keys q,w,e, and r correspond to special events 1,2,3 and 4. A two digit numeric value must follow the shortcut letter, e.g. 'q75', when the corresponding event slider max value is 100 or less (default setting). When the slider max value is greater than 100, three digits must be entered and for values less than 100 a leading zero is required, e.g. 'q075'. | -
| V + <value> | -Quick PID SV Entry. Value is a three digit number. For values less than 100 must be entered with a leading zero, e.g. 'v075'. | -
| OPTION+B + <value> [Mac] CTRL+SHIFT+B + <value> [Win] |
- Fire custom event button action. Value is a two digit number indicating the button number. | -
| F CTRL+SHIFT+F [Win] |
- Full Screen Mode | -
| Key/mouse stroke(s) | -Where | -Action | -Additional Information | -
|---|---|---|---|
| Double click on Roast Title | -Graph | -Open the roast in artisan.plus | -Requires an artisan.plus account | -
| Double Click on Background Profile Title | -Graph & Designer | -Toggle Show/Hide Background Profile | -Only when a Background profile is loaded | -
| Right click on BT curve | -Graph | -Place or re-place events | -- |
| Right click on timer | -Graph | -Toggle super mode | -- |
| Right click on characteristics line below graph | -Graph | -Toggle set of characteristics displayed | -Characteristics must be enabled in Config>> Statistics | -
| Click on plus icon (when not red) | -Graph | -Toggle connect/disconnect to plus | -- |
| Click on plus icon (when it is red) | -Graph | -Sync the roast with artisan.plus | -- |
| ⌘ click on plus icon [Mac] CTRL click on plus icon [Win] |
- Graph | -When connected to plus, disconnect and clear credentials | -- |
| OPTION click on plus icon [Mac] ALT click on plus icon [Win] |
- Graph | -Generate email message with Artisan Logs | -- |
| ⌘+OPTION click on plus icon [Mac] CTRL+ALT click on plus icon [Win] |
- Graph | -Toggle debug logging mode | -- |
| Click on LCD | -Graph | -Hide or Show corresponding Curve | -In OFF state this changes the Artisan Settings, in ON/START states the change is temporary until OFF state | -
| Click on label in the Legend | -Graph | -Hide or Show corresponding Curve | -Only in OFF state when the Legend is displayed | -
| OPTION click 'RESET' Button [Mac] ALT click 'RESET' Button [Win] |
- Graph | -Detach IO Phidgets | -- |
| ⌘ click 'CONTROL' Button [Mac] CTRL click 'CONTROL' Button [Win] |
- Graph | -Toggle PID Standby on and off | -Device = Fuji or Delta | -
| ⌘ click 'CONTROL' Button [Mac] CTRL click 'CONTROL' Button [Win] |
- Graph | -Opens PID dialog | -Device = Hottop | -
| ⌘ click 'CONTROL' Button [Mac] CTRL click 'CONTROL' Button [Win] |
- Graph | -Toggle PID | -Device = <all others>, Control enabled in Config>> Device | -
| ⌘+PLUS, ⌘+MINUS [Mac] CTRL+SHIFT+PLUS, CTRL+MINUS [Win] |
- Graph | -Increase or Decrease Graph Resolution % | -Same as Config>> Curves>> UI tab>> Graph % +/- | -
| TAB | -Graph when Sliders visible | -Sequence slider select | -Requires Keyboard Control enabled in Config>> Events Keyboard Shortcuts must be turned off (ENTER) |
-
| UP,DOWN,RIGHT,LEFT | -Graph when Sliders visible | -Increment selected slider up or down by step amount | -Requires Keyboard Control enabled in Config>> Events Keyboard Shortcuts must be turned off (ENTER) |
-
| OPTION+UP, OPTION+DOWN [Mac] PAGEUP,PAGEDOWN [Win] |
- Graph when Sliders visible | -Increment selected slider up or down by 10 | -Requires Keyboard Control enabled in Config>> Events Keyboard Shortcuts must be turned off (ENTER) |
-
| HOME,END | -Graph when Sliders visible | -Set selected slider to minimum or maximum value | -Requires Keyboard Control enabled in Config>> Events Keyboard Shortcuts must be disabled (ENTER) |
-
| Click on timer | -Simulator | -Toggle Pause/Continue Simulation | -Simulator speed may be changd while paused (hold shift (1x), OPTION/ALT (2x) or COMMAND/CTRL (4x) on restart). | -
| OPTION Tools>>Simulator [Mac] ALT Tools>>Simulator [Win] |
- Graph/Simulator | -Start or change Simulator speed to 2x mode | -- |
| ⌘ Tools>>Simulator [Mac] CTRL Tools>>Simulator [Win] |
- Graph/Simulator | -Start or change Simulator speed to 4x mode | -- |
| ⌘+L [Mac] CTRL+L [Win] |
- Roast Properties Roast tab | -Open volume calculator | -- |
| OPTION click Stock [Mac] ALT click Stock [Win] |
- Roast Properties Roast tab | -Show plus Stock in alternate weight unit from Artisan setting (imperial <-> metric) | -Requires a connection to plus | -
| OPTION click '+' button [Mac] ALT click '+' button [Win] |
- Roast Properties Roast tab | -Adds Weight Roasted, Volume Roasted, Moisture Roasted, ColorWhole, and Color Ground to the recent roast | -- |
| OPTION File>> New>> <recent-roast> [Mac] ALT File>> New>> <recent-roast> [Win] |
- Roast Properties Roast tab | -Sets roast properties to <recent-roast> without starting a new roast | -- |
| ⌘+I [Mac] CTRL+I [Win] |
- Roast Properties Roast tab | -Adds scale weight to Green Weight field (same action as 'in' button) | -Requires a connected scale | -
| ⌘+O [Mac] CTRL+O [Win] |
- Roast Properties Roast tab | -Adds scale weight to Roasted Weight field (same action as 'out' button) | -Requires a connected scale | -
| ⌘+P [Mac] CTRL+P [Win] |
- Roast Properties Roast tab | -Clear accumulated scale weight preview display (same as clicking on the preview display) | -Requires a connected scale | -
| Enter | -Roast Properties Roast Tab Volume Calculator Unit, Green Unit Weight or Roasted Unit Weight field |
- Overwrite with current scale weight (same action as 'unit', 'in', 'out' buttons) | -Requires a connected scale | -
| Enter | -Roast Properties Roast tab Green Weight or Roasted Weight field |
- Overwrite with current scale weight | -Requires a connected scale | -
| ⌘+C [Mac] CTRL+C [Win] |
- Roast Properties Data tab | -Copy table | -- |
| OPTION click 'Copy Table' Button [Mac] ALT click 'Copy Table' Button [Win] |
- Various | -For various tables this copies the table in tabular form | -- |
| Click on Home Icon While recording only |
- Navigation Toolbar | -Toggle Zoom Follow (automatic panning) | -Zoom action while recording sets Follow ON | -
| Hold Shift+Option [Mac] Hold Shift+Alt [Win] |
- When starting Artisan | -Skip Settings Load | -- |
| Hold Shift+Option [Mac] Hold Shift+Alt [Win] |
- When quitting Artisan | -Skip Settings Save | -- |
| Hold Shift+Option [Mac] Hold Shift+Alt [Win] |
- When opening a profile (.alog file) | -Skip creating settings cache and ask user to apply existing settings or settings from profile | -- |
| Keys | -Menu | -Action | -
|---|---|---|
| ⌘+O [Mac] CTRL+O [Win] |
- File | -Open | -
| ⌘+S [Mac] CTRL+S [Win] |
- File | -Save | -
| ⌘+P [Mac] CTRL+P [Win] |
- File | -|
| ⌘+X [Mac] CTRL+X [Win] |
- Edit | -Cut | -
| ⌘+C [Mac] CTRL+C [Win] |
- Edit | -Copy | -
| ⌘+V [Mac] CTRL+V [Win] |
- Edit | -Paste | -
| ⌘+T [Mac] CTRL+T [Win] |
- Roast | -Open Roast Properties dialog | -
| ⌘+B [Mac] CTRL+B [Win] |
- Roast | -Open Profile Background dialog | -
| ⌘+F4 [Mac] CTRL+F4 [Win] |
- Roast | -Switch Profiles (Foreground<=>Background) | -
| ⌘+D [Mac] CTRL+D [Win] |
- Config | -Open Devices dialog | -
| ⌘+U [Mac] CTRL+U [Win] |
- Config | -Open Curves dialog | -
| ⌘+E [Mac] CTRL+E [Win] |
- Config | -Open Events dialog | -
| ⌘+A [Mac] CTRL+A [Win] |
- Config | -Open Alarms dialog | -
| ⌘+SHIFT+A [Mac] CTRL+SHIFT+A [Win] |
- Config | -Open Axes dialog | -
| ⌘+K [Mac] CTRL+K [Win] |
- Tools | -Analyzer Auto All | -
| ⌘+OPTION+A [Mac] CTRL+ALT+K [Win] |
- Tools | -Analyzer Clear Results | -
| ⌘+L [Mac] CTRL+L [Win] |
- View | -Show/Hide Large Main LCDs | -
| ⌘+F [Mac] CTRL+SHIFT+F [Win] |
- View | -Toggle Full Screen Mode | -
| F1 | -Help | -Open QuickStart Guide in the system browser | -
| Keys | +Description | +
|---|---|
| ENTER | +Turns ON/OFF Keyboard Shortcuts | +
| ⌘-ENTER [Mac] CTRL+ENTER [Win] |
+ Starts recording | +
| SHIFT-ENTER | +Turns Artisan OFF | +
| SPACE | +When Keyboard Shortcuts are ON chooses the current button When Keyboard Shortcuts are OFF adds a custom event When Meter=NONE opens dialog to manually enter temperatures during roast |
+
| LEFT,RIGHT | +Change roast event key focus | +
| LEFT,RIGHT,UP,DOWN | +Move background (when sliders not visible or when Config>> Events>> Sliders tab>> Keyboard Control is not selected) | +
| A | +Autosave | +
| ⌘-N [Mac] CRTL+N [Win] |
+ Autosave + RESET + START | +
| T [Mac] CTRL+SHIFT+T [Win] |
+ Toggle mouse cross lines | +
| G | +Toggle auto axis mode between Roast, BBP+Roast and BBP | +
| D | +Toggle xy cursor mode (off/temp/delta) | +
| Z | +Toggle xy cursor clamp mode (off/BT/ET/BTB/ETB) | +
| U | +Toggle LCD cursor (off/profile/background) | +
| C | +Shows/Hides Controls | +
| X | +Shows/Hides LCD Readings | +
| Y | +Shows/Hides Mini Event editor (on recording) | +
| M | +Shows/Hides Event Buttons | +
| B | +Shows/Hides Extra Event Buttons | +
| S | +Shows/Hides Event Sliders | +
| P | +Toggle PID mode | +
| J | +Toggle Playback Events | +
| H CTRL+H [Win] |
+ Load background profile | +
| OPTION+H [Mac] CTRL+SHIFT+H [Win] |
+ Remove background profile | +
| I | +Toggle foreground curves “show full” | +
| O | +Toggle background curves “show full” | +
| L | +Load alarms | +
| +,- | +Inc/dec PID lookahead | +
| ⌘ +,- [Mac] CRTL +,- [Win] |
+ Inc/dec graph resolution | +
| ⌘ 0-9 [Mac] CRTL 0-9 [Win] |
+ Changes Event Button Palettes | +
| ; | +Application ScreenShot | +
| : | +Desktop ScreenShot | +
| Q,W,E,R + <value> | +Quick Special Event Entry. The keys q,w,e, and r correspond to special events 1,2,3 and 4. A two digit numeric value must follow the shortcut letter, e.g. 'q75', when the corresponding event slider max value is 100 or less (default setting). When the slider max value is greater than 100, three digits must be entered and for values less than 100 a leading zero is required, e.g. 'q075'. | +
| V + <value> | +Quick PID SV Entry. Value is a three digit number. For values less than 100 must be entered with a leading zero, e.g. 'v075'. | +
| OPTION+B + <value> [Mac] CTRL+SHIFT+B + <value> [Win] |
+ Fire custom event button action. Value is a two digit number indicating the button number. | +
| F CTRL+SHIFT+F [Win] |
+ Full Screen Mode | +
| Key/mouse stroke(s) | +Where | +Action | +Additional Information | +
|---|---|---|---|
| Double click on Roast Title | +Graph | +Open the roast in artisan.plus | +Requires an artisan.plus account | +
| Double Click on Background Profile Title | +Graph & Designer | +Toggle Show/Hide Background Profile | +Only when a Background profile is loaded | +
| Right click on BT curve | +Graph | +Place or re-place events | ++ |
| Right click on timer | +Graph | +Toggle super mode | ++ |
| Right click on characteristics line below graph | +Graph | +Toggle set of characteristics displayed | +Characteristics must be enabled in Config>> Statistics | +
| Click on plus icon (when not red) | +Graph | +Toggle connect/disconnect to plus | ++ |
| Click on plus icon (when it is red) | +Graph | +Sync the roast with artisan.plus | ++ |
| ⌘ click on plus icon [Mac] CTRL click on plus icon [Win] |
+ Graph | +When connected to plus, disconnect and clear credentials | ++ |
| OPTION click on plus icon [Mac] ALT click on plus icon [Win] |
+ Graph | +Generate email message with Artisan Logs | ++ |
| ⌘+OPTION click on plus icon [Mac] CTRL+ALT click on plus icon [Win] |
+ Graph | +Toggle debug logging mode | ++ |
| Click on LCD | +Graph | +Hide or Show corresponding Curve | +In OFF state this changes the Artisan Settings, in ON/START states the change is temporary until OFF state | +
| Click on label in the Legend | +Graph | +Hide or Show corresponding Curve | +Only in OFF state when the Legend is displayed | +
| OPTION click 'RESET' Button [Mac] ALT click 'RESET' Button [Win] |
+ Graph | +Detach IO Phidgets | ++ |
| ⌘ click 'CONTROL' Button [Mac] CTRL click 'CONTROL' Button [Win] |
+ Graph | +Toggle PID Standby on and off | +Device = Fuji or Delta | +
| ⌘ click 'CONTROL' Button [Mac] CTRL click 'CONTROL' Button [Win] |
+ Graph | +Opens PID dialog | +Device = Hottop | +
| ⌘ click 'CONTROL' Button [Mac] CTRL click 'CONTROL' Button [Win] |
+ Graph | +Toggle PID | +Device = <all others>, Control enabled in Config>> Device | +
| ⌘+PLUS, ⌘+MINUS [Mac] CTRL+SHIFT+PLUS, CTRL+MINUS [Win] |
+ Graph | +Increase or Decrease Graph Resolution % | +Same as Config>> Curves>> UI tab>> Graph % +/- | +
| TAB | +Graph when Sliders visible | +Sequence slider select | +Requires Keyboard Control enabled in Config>> Events Keyboard Shortcuts must be turned off (ENTER) |
+
| UP,DOWN,RIGHT,LEFT | +Graph when Sliders visible | +Increment selected slider up or down by step amount | +Requires Keyboard Control enabled in Config>> Events Keyboard Shortcuts must be turned off (ENTER) |
+
| OPTION+UP, OPTION+DOWN [Mac] PAGEUP,PAGEDOWN [Win] |
+ Graph when Sliders visible | +Increment selected slider up or down by 10 | +Requires Keyboard Control enabled in Config>> Events Keyboard Shortcuts must be turned off (ENTER) |
+
| HOME,END | +Graph when Sliders visible | +Set selected slider to minimum or maximum value | +Requires Keyboard Control enabled in Config>> Events Keyboard Shortcuts must be disabled (ENTER) |
+
| Click on timer | +Simulator | +Toggle Pause/Continue Simulation | +Simulator speed may be changd while paused (hold shift (1x), OPTION/ALT (2x) or COMMAND/CTRL (4x) on restart). | +
| OPTION Tools>>Simulator [Mac] ALT Tools>>Simulator [Win] |
+ Graph/Simulator | +Start or change Simulator speed to 2x mode | ++ |
| ⌘ Tools>>Simulator [Mac] CTRL Tools>>Simulator [Win] |
+ Graph/Simulator | +Start or change Simulator speed to 4x mode | ++ |
| ⌘+L [Mac] CTRL+L [Win] |
+ Roast Properties Roast tab | +Open volume calculator | ++ |
| OPTION click Stock [Mac] ALT click Stock [Win] |
+ Roast Properties Roast tab | +Show plus Stock in alternate weight unit from Artisan setting (imperial <-> metric) | +Requires a connection to plus | +
| OPTION click '+' button [Mac] ALT click '+' button [Win] |
+ Roast Properties Roast tab | +Adds Weight Roasted, Volume Roasted, Moisture Roasted, ColorWhole, and Color Ground to the recent roast | ++ |
| OPTION File>> New>> <recent-roast> [Mac] ALT File>> New>> <recent-roast> [Win] |
+ Roast Properties Roast tab | +Sets roast properties to <recent-roast> without starting a new roast | ++ |
| ⌘+I [Mac] CTRL+I [Win] |
+ Roast Properties Roast tab | +Adds scale weight to Green Weight field (same action as 'in' button) | +Requires a connected scale | +
| ⌘+O [Mac] CTRL+O [Win] |
+ Roast Properties Roast tab | +Adds scale weight to Roasted Weight field (same action as 'out' button) | +Requires a connected scale | +
| ⌘+P [Mac] CTRL+P [Win] |
+ Roast Properties Roast tab | +Clear accumulated scale weight preview display (same as clicking on the preview display) | +Requires a connected scale | +
| Enter | +Roast Properties Roast Tab Volume Calculator Unit, Green Unit Weight or Roasted Unit Weight field |
+ Overwrite with current scale weight (same action as 'unit', 'in', 'out' buttons) | +Requires a connected scale | +
| Enter | +Roast Properties Roast tab Green Weight or Roasted Weight field |
+ Overwrite with current scale weight | +Requires a connected scale | +
| ⌘+C [Mac] CTRL+C [Win] |
+ Roast Properties Data tab | +Copy table | ++ |
| OPTION click 'Copy Table' Button [Mac] ALT click 'Copy Table' Button [Win] |
+ Various | +For various tables this copies the table in tabular form | ++ |
| Click on Home Icon While recording only |
+ Navigation Toolbar | +Toggle Zoom Follow (automatic panning) | +Zoom action while recording sets Follow ON | +
| Hold Shift+Option [Mac] Hold Shift+Alt [Win] |
+ When starting Artisan | +Skip Settings Load | ++ |
| Hold Shift+Option [Mac] Hold Shift+Alt [Win] |
+ When quitting Artisan | +Skip Settings Save | ++ |
| Hold Shift+Option [Mac] Hold Shift+Alt [Win] |
+ When opening a profile (.alog file) | +Skip creating settings cache and ask user to apply existing settings or settings from profile | ++ |
| Keys | +Menu | +Action | +
|---|---|---|
| ⌘+O [Mac] CTRL+O [Win] |
+ File | +Open | +
| ⌘+S [Mac] CTRL+S [Win] |
+ File | +Save | +
| ⌘+P [Mac] CTRL+P [Win] |
+ File | +|
| ⌘+X [Mac] CTRL+X [Win] |
+ Edit | +Cut | +
| ⌘+C [Mac] CTRL+C [Win] |
+ Edit | +Copy | +
| ⌘+V [Mac] CTRL+V [Win] |
+ Edit | +Paste | +
| ⌘+T [Mac] CTRL+T [Win] |
+ Roast | +Open Roast Properties dialog | +
| ⌘+B [Mac] CTRL+B [Win] |
+ Roast | +Open Profile Background dialog | +
| ⌘+F4 [Mac] CTRL+F4 [Win] |
+ Roast | +Switch Profiles (Foreground<=>Background) | +
| ⌘+D [Mac] CTRL+D [Win] |
+ Config | +Open Devices dialog | +
| ⌘+U [Mac] CTRL+U [Win] |
+ Config | +Open Curves dialog | +
| ⌘+E [Mac] CTRL+E [Win] |
+ Config | +Open Events dialog | +
| ⌘+A [Mac] CTRL+A [Win] |
+ Config | +Open Alarms dialog | +
| ⌘+SHIFT+A [Mac] CTRL+SHIFT+A [Win] |
+ Config | +Open Axes dialog | +
| ⌘+K [Mac] CTRL+K [Win] |
+ Tools | +Analyzer Auto All | +
| ⌘+OPTION+A [Mac] CTRL+ALT+K [Win] |
+ Tools | +Analyzer Clear Results | +
| ⌘+L [Mac] CTRL+L [Win] |
+ View | +Show/Hide Large Main LCDs | +
| ⌘+F [Mac] CTRL+SHIFT+F [Win] |
+ View | +Toggle Full Screen Mode | +
| F1 | +Help | +Open QuickStart Guide in the system browser | +
| MODBUS SETTINGS | -
|---|
| The MODBUS serial protocols RTU, ASCII, and Binary is using the specified serial port parameters. The MODBUS IP protocol on TCP and UDP is respecting the host IP and port. | -
| The inputs 1+2 configure the MODBUS device, inputs 3+4 configure the MODBUS_34 device and so on. Inputs with the slave id set to 0 are turned off. |
-
| Function 1 (Read Coils): registers 0 to 65535 corresponding to numbers 000001 to 065536 Function 2 (Read Discrete Inputs): registers 0 to 65535 corresponding to numbers 100001 to 165536 Function 3 (Read Multiple Holding Registers): registers 0 to 65535 corresponding to numbers 400001 to 465536 Function 4 (Read Input Registers): registers 0 to 65535 corresponding to numbers 300001 to 365536 |
-
| Dividers 1/10 and 1/100 can be set to recreate decimals of floats transported as integers multiplied by 10 or 100. Eg. a value of 145.2 might be transmitted as 1452, which is turned back into 145.2 by the 1/10 divider. | -
| Temperature readings are automatically converted based on the specified unit per input channel. | -
| If a 32bit decoder is set two succeeding 16bit registers are requested and the received 4 bytes are interpreted using the byte and word order as specified by the corresponding flag. | -
| The PID Control dialog can operate a connected PID slave using the given PID registers to set the p-i-d parameters and the set value (SV). MODBUS commands can be specified to turn the PID slave on and off from that PID Control dialog. See the help page in the Events Dialog for documentation of available MODBUS write commands. | -
| The Scan button opens a simple MODBUS scanner to search for data holding registers in the connected device. | -
| Refer to the User Manual of your MODBUS device for information specific to the setup required for your device. | -
| MODBUS SETTINGS | +
|---|
| The MODBUS serial protocols RTU, ASCII, and Binary is using the specified serial port parameters. The MODBUS IP protocol on TCP and UDP is respecting the host IP and port. | +
| The inputs 1+2 configure the MODBUS device, inputs 3+4 configure the MODBUS_34 device and so on. Inputs with the slave id set to 0 are turned off. |
+
| Function 1 (Read Coils): registers 0 to 65535 corresponding to numbers 000001 to 065536 Function 2 (Read Discrete Inputs): registers 0 to 65535 corresponding to numbers 100001 to 165536 Function 3 (Read Multiple Holding Registers): registers 0 to 65535 corresponding to numbers 400001 to 465536 Function 4 (Read Input Registers): registers 0 to 65535 corresponding to numbers 300001 to 365536 |
+
| Dividers 1/10 and 1/100 can be set to recreate decimals of floats transported as integers multiplied by 10 or 100. Eg. a value of 145.2 might be transmitted as 1452, which is turned back into 145.2 by the 1/10 divider. | +
| Temperature readings are automatically converted based on the specified unit per input channel. | +
| If a 32bit decoder is set two succeeding 16bit registers are requested and the received 4 bytes are interpreted using the byte and word order as specified by the corresponding flag. | +
| The PID Control dialog can operate a connected PID slave using the given PID registers to set the p-i-d parameters and the set value (SV). MODBUS commands can be specified to turn the PID slave on and off from that PID Control dialog. See the help page in the Events Dialog for documentation of available MODBUS write commands. | +
| The Scan button opens a simple MODBUS scanner to search for data holding registers in the connected device. | +
| Refer to the User Manual of your MODBUS device for information specific to the setup required for your device. | +
| Link external programs that print temperature when called. This allows to connect meters that use any program language. Artisan will start the program each sample period. The program output must be to stdout (like when using print statements). The program must exit and must not be persistent. If only one temperature is provided it will be interpreted as BT. If more than one temperature is provided the values are order dependent with ET first and BT second. Data may also be provided to the "Program" extra devices. Extra device "Program" are the first two values, typically ET and BT. "Program 34" are the third and fourth values. Up to 10 values may be supplied. Example of output needed from program for single temperature (BT): "100.4" (note: "" not needed) Example of output needed from program for double temperature (ET,BT) "200.4,100.4" (note: temperatures are separated by a comma "ET,BT") Example of output needed from program for double temperature (ET,BT) and extra devices (Program and Program 34) "200.4,100.4,312.4,345.6,299.0,275.5" |
-
| Example of a file written in Python called test.py: #comment: print a string with two numbers separated by a comma #!/usr/bin/env python print("237.1,100.4") Note: In many cases the path to the Python or other language executatable should be provided along with the external program path. On Windows it is advised to enclose the paths with quotation marks if there are any spaces, and use forward slashes '/' in the path. "C:/Python38-64/python.exe" "c:/scripts/test.py" Under Output a script can be specified which is called per sample interval with 4 arguments, ET, BT, Background ET and Background BT the output script also called if Prog is not selected as input source Example of a file written in Python called out.py: #comment: adds the script arguments ET, BT, ETB, BTB to "/tmp/out.txt" #!/usr/bin/env python import sys ET, BT, ETB, BTB = sys.argv[1:] with open("/tmp/out.txt", "w+") as file: file.write(f'ET: {ET}, BT: {ET}, ETB: {ETB}, BTB: {BTB};') |
-
| Link external programs that print temperature when called. This allows to connect meters that use any program language. Artisan will start the program each sample period. The program output must be to stdout (like when using print statements). The program must exit and must not be persistent. If only one temperature is provided it will be interpreted as BT. If more than one temperature is provided the values are order dependent with ET first and BT second. Data may also be provided to the "Program" extra devices. Extra device "Program" are the first two values, typically ET and BT. "Program 34" are the third and fourth values. Up to 10 values may be supplied. Example of output needed from program for single temperature (BT): "100.4" (note: "" not needed) Example of output needed from program for double temperature (ET,BT) "200.4,100.4" (note: temperatures are separated by a comma "ET,BT") Example of output needed from program for double temperature (ET,BT) and extra devices (Program and Program 34) "200.4,100.4,312.4,345.6,299.0,275.5" |
+
| Example of a file written in Python called test.py: #comment: print a string with two numbers separated by a comma #!/usr/bin/env python print("237.1,100.4") Note: In many cases the path to the Python or other language executatable should be provided along with the external program path. On Windows it is advised to enclose the paths with quotation marks if there are any spaces, and use forward slashes '/' in the path. "C:/Python38-64/python.exe" "c:/scripts/test.py" Under Output a script can be specified which is called per sample interval with 4 arguments, ET, BT, Background ET and Background BT the output script also called if Prog is not selected as input source Example of a file written in Python called out.py: #comment: adds the script arguments ET, BT, ETB, BTB to "/tmp/out.txt" #!/usr/bin/env python import sys ET, BT, ETB, BTB = sys.argv[1:] with open("/tmp/out.txt", "w+") as file: file.write(f'ET: {ET}, BT: {ET}, ETB: {ETB}, BTB: {BTB};') |
+
| S7 SETTINGS | -
|---|
| The Siemens S7 is respecting the host IP and port. | -
| The inputs 1+2 configure the S7 device, inputs 3+4 configure the S7_34 device and so on. Inputs with the area set to the empty input are turned off. |
-
| Factors 1/10 and 1/100 can be set as dividers to recreate decimals of floats transported as integers multiplied by 10 or 100. Eg. a value of 145.2 might be transmitted as 1452, which is turned back into 145.2 by the 1/10 divider. | -
| Temperature readings are automatically converted based on the specified unit per input channel. | -
| If mode is set to C or F, readings are automatically converted to the temperature unit set for display. | -
| The PID Control dialog can operate a connected PID slave using the given PID registers to set the p-i-d parameters and the set value (SV). S7 commands can be specified to turn the PID slave on and off from that PID Control dialog. See the help page in the Events Dialog for documentation of available S7 write commands. | -
| The Scan button opens a simple MODBUS scanner to search for data holding registers in the connected device. | -
| Refer to the User Manual of your MODBUS device for information specific to the setup required for your device. | -
| S7 SETTINGS | +
|---|
| The Siemens S7 is respecting the host IP and port. | +
| The inputs 1+2 configure the S7 device, inputs 3+4 configure the S7_34 device and so on. Inputs with the area set to the empty input are turned off. |
+
| Factors 1/10 and 1/100 can be set as dividers to recreate decimals of floats transported as integers multiplied by 10 or 100. Eg. a value of 145.2 might be transmitted as 1452, which is turned back into 145.2 by the 1/10 divider. | +
| Temperature readings are automatically converted based on the specified unit per input channel. | +
| If mode is set to C or F, readings are automatically converted to the temperature unit set for display. | +
| The PID Control dialog can operate a connected PID slave using the given PID registers to set the p-i-d parameters and the set value (SV). S7 commands can be specified to turn the PID slave on and off from that PID Control dialog. See the help page in the Events Dialog for documentation of available S7 write commands. | +
| The Scan button opens a simple MODBUS scanner to search for data holding registers in the connected device. | +
| Refer to the User Manual of your MODBUS device for information specific to the setup required for your device. | +
| Symbol | -Description | -Can shift? (see below) |
-
|---|---|---|
| t | -Absolute time (seconds) from begin of recording (not only the time after CHARGE!) | -Yes | -
| b | -Absolute time (seconds) from begin of recording of the background profile | -Yes | -
| x | -Current channel reading (not available in the Plotter) | -- |
| Y1 | -ET value | -Yes | -
| Y2 | -BT value | -Yes | -
| Y3 | -Extra #1 T1 value | -Yes | -
| Y4 | -Extra #1 T2 value | -Yes | -
| Y5 | -Extra #2 T1 value | -Yes | -
| Y6 | -Extra #2 T2 value | -Yes | -
| ... | -...and so forth | -Yes | -
| B1 | -ET background | -Yes | -
| B2 | -BT background | -Yes | -
| B3 | -ExtraBackground #1-A | -Yes | -
| B4 | -ExtraBackground #1-B | -Yes | -
| B5 | -ExtraBackground #2-A | -Yes | -
| ... | -...and so forth | -Yes | -
| T1 | -ET tare value | -- |
| T2 | -BT tare value | -- |
| T3 | -Extra Device #1 channel 1 tare value | -- |
| T4 | -Extra Device #1 channel 2 tare value | -- |
| T5 | -Extra Device #2 channel 1 tare value | -- |
| ... | -...and so forth | -- |
| E1 | -Last event value of the first event type | -- |
| E2 | -Last event value of the second event type | -- |
| E3 | -Last event value of the third event type | -- |
| E4 | -Last event value of the fourth event type | -- |
| - | - | - |
| R1 | -ET rate of rise | -Yes | -
| R2 | -BT rate of rise | -Yes | -
| RB1 | -Background ET rate of rise | -Yes | -
| RB2 | -Background BT rate of rise | -Yes | -
| The symbolic variables t, b, Y<n>, B<n> and R<n> evaluate to the current value of a sequence of values that define a roast profile. To access earlier or later values one can apply a shift value. For example, while "Y2" returns the current bean temperature (BT), "Y2[-1]" returns the previous BT temperature and "Y2[-2]" the one before that. Formulas used in the Plotter are applied in sequence to all values, thus there "Y2" points to the current BT temperature processed, "Y2[-1]" the previous BT temperature processed and "Y2[+1]" the next BT temperature to be processed. A positive shift is only available in the Plotter, obviously not during recording. |
-
| Example | -Description | -
|---|---|
| t[+1] | -Time one index ahead (plotter only) | -
| t[-3] | -Time three indexes delayed | -
| Y1[-2] | -ET value delayed by 2 indexes | -
| Y2[+1] | -BT value index advanced by one index (plotter only) | -
| B4[-6] | -ExtraBackground #1-B delayed 6 indexes | -
| B5[+2] | -ExtraBackground #2-A advanced 2 indexes (plotter only) | -
| R1[-2] | -ET rate of rise delayed two indexes | -
| Symbol | -Description | -
|---|---|
| t, b, Y<n>, B<n> and R<n> | -Previously recorded data assigned to the symbolic variables t, b, Y<n>, B<n> and R<n> can also directly accessed by index. "Y2{0}" evaluates to the first recorded bean temperature (BT) and "Y2{CHARGE}" to the bean temperature at CHARGE. Additionally, the symbolic variable b can be used to access the recording time at a certain index of the background profile. Thus "b{CHARGE}" returns the recording time at CHARGE of the background profile. | -
| Symbol | -Description | -
|---|---|
| k | -Scaling factor from RoR to Temp axis. The range of the temperature scale divided by the range of the delta scale. | -
| o | -Offset from RoR to Temp axis. | -
| Note: RoR values r can be scaled to the temperature axis using a linear approximation of the form "r*k + o". As the variables k and o depend on the actual axis settings which can be changed by the user without triggering a recomputation, those variable are less useful for use in a recording, but useful in the Plotter to plot w.r.t. the RoR y-axis instead of the temperature y-axis. | -
| Symbol | -Description | -
|---|---|
| CHARGE, DRY, FCs, FCe, SCs, SCe, DROP | -Index of the corresponding event of the profile to retrieve time and values from the corresponding data structures. Evaluates to -1 if not set. | -
| bCHARGE, bDRY, bFCs, bFCe, bSCs, bSCe, bDROP | -Index of the corresponding event of the background profile to retrieve time and values from the corresponding data structures. Evaluates to -1 if not set. | -
| - | - |
| dCHARGE, dDRY, dFCs, dFCe, dSCs, dSCe, dDROP | -Time distance in seconds after the corresponding event. Thus dCHARGE is bound to the current roast time (after CHARGE) in seconds while t is bound to the time in seconds from the start of the recording. | -
| Symbol | -Description | -
|---|---|
| AUCbase | -AUC base temperature (could be from the selected event, if set) | -
| AUCtarget | -AUC target value (could be from the background profile, if set) | -
| AUCvalue | -the current AUC value. -1 if none available. | -
| Symbol | -Description | -
|---|---|
| pDRY | -Prediction of the time distance to the DRY event based on the current RoR. Evaluates to -1 on negative RoR and to 0 if the DRY event is already set. | -
| pFCs | -Same as pDRY, just for the FCs event. | -
| Note: The same rules as for the corresponding PhasesLCDs apply to pDRY and pFCs: If there is no background profile the DRY or FCs bean temperature used for the prediction is taken from the Config>Phases setup. If there is a background profile and there is DRY or FCs event in the background profile, the DRY or FCs bean temperature used for the prediction is taken from the background profile. Exception to the above for DRY only: if AutoDRY is checked the DRY temperature used for the prediction is taken from the Config>Phases setup. This does not apply to FCs and AutoFCs. The prediction value is the calculated time in seconds to reach the DRY or FCs temperature. |
-
| Symbol | -Description | -
|---|---|
| aTMP | -ambient temperature (default 0) | -
| aHUM | -ambient humidity (default 0) | -
| aPRE | -ambient pressure (default 0) | -
| Note: The data is (re-)sampled some seconds after the start of recording | -
| Symbol | -Description | -
|---|---|
| WEIGHTin | -batch size (g) | -
| MOISTUREin | -green moisture (%) | -
| TEMPunit | -temperature unit (Celsius: 0, Fahrenheit: 1) | -
| Expression | -Description | -
|---|---|
| (<true-expr> if <cond> else <false-expr>) | -Conditional. Evaluates to the value of the expression <true-expr> if the condition <cond> holds, otherwise to the value of the expression <false-expr>. The rules of Python are applied to decide if a value holds or not. Thus the boolean values "True" and "False" have the obvious semantic. Any number unequal to 0 evaluates to True and 0 evaluates to False. The value "None" is also evaluated to False. | -
| Formula | -Description | -
|---|---|
| abs(x) | -Return the absolute value of x. | -
| acos(x) | -Return the arc cosine (measured in radians) of x. | -
| asin(x) | -Return the arc sine (measured in radians) of x. | -
| atan(x) | -Return the arc tangent (measured in radians) of x. | -
| cos(x) | -Return the cosine of x (measured in radians). | -
| degrees(x) | -Convert angle x from radians to degrees. | -
| exp(x) | -Return e raised to the power of x. | -
| log(x[, base]) | -Return the logarithm of x to the given base. | -
| min(x1,...,xn) | -Return the minimum of the given values. | -
| max(x1,...,xn) | -Return the maximum of the given values. | -
| pow(x, y) | -Return x**y (x to the power of y). | -
| radians(x) | -Convert angle x from degrees to radians. | -
| sin(x) | -Return the sine of x (measured in radians). | -
| sqrt(x) | -Return the square root of x. | -
| tan(x) | -Return the tangent of x (measured in radians). | -
| bit(n,x) | -Return 1 if the bit n of value x (interpreted as integer) is set, otherwise 0. | -
| Symbol | -Value | -
|---|---|
| e | -2.71828182845904 | -
| pi | -3.14159265358979 | -
| Note: This section applies only to the Plotter Using math formulas in the plotter also allows to use the symbolic variables P and F (see Signals, Symbolic Assignments and the Plotter). |
-
| Symbol | -Description | -
|---|---|
| P1...P9 | -The variables P1,..,P9 represent the results from plot #1,..,#9. You can perform calculations in a later plot on variables of an earlier plot. That way, the plot variables P1,..,P9 allow the cascading or intermediate results. For example, plot #3 can refer to the results of plot 1 using the variable P1. | -
| F1...F9 | -F1 refers to the previous result of the actual formula to realize a feedback loop. This is useful in filter designs. Similarly, F2 refers to the second previous result etc. | -
| Symbol | +Description | +Can shift? (see below) |
+
|---|---|---|
| t | +Absolute time (seconds) from begin of recording (not only the time after CHARGE!) | +Yes | +
| b | +Absolute time (seconds) from begin of recording of the background profile | +Yes | +
| x | +Current channel reading (not available in the Plotter) | ++ |
| Y1 | +ET value | +Yes | +
| Y2 | +BT value | +Yes | +
| Y3 | +Extra #1 T1 value | +Yes | +
| Y4 | +Extra #1 T2 value | +Yes | +
| Y5 | +Extra #2 T1 value | +Yes | +
| Y6 | +Extra #2 T2 value | +Yes | +
| ... | +...and so forth | +Yes | +
| B1 | +ET background | +Yes | +
| B2 | +BT background | +Yes | +
| B3 | +ExtraBackground #1-A | +Yes | +
| B4 | +ExtraBackground #1-B | +Yes | +
| B5 | +ExtraBackground #2-A | +Yes | +
| ... | +...and so forth | +Yes | +
| T1 | +ET tare value | ++ |
| T2 | +BT tare value | ++ |
| T3 | +Extra Device #1 channel 1 tare value | ++ |
| T4 | +Extra Device #1 channel 2 tare value | ++ |
| T5 | +Extra Device #2 channel 1 tare value | ++ |
| ... | +...and so forth | ++ |
| E1 | +Last event value of the first event type | ++ |
| E2 | +Last event value of the second event type | ++ |
| E3 | +Last event value of the third event type | ++ |
| E4 | +Last event value of the fourth event type | ++ |
| + | + | + |
| R1 | +ET rate of rise | +Yes | +
| R2 | +BT rate of rise | +Yes | +
| RB1 | +Background ET rate of rise | +Yes | +
| RB2 | +Background BT rate of rise | +Yes | +
| The symbolic variables t, b, Y<n>, B<n> and R<n> evaluate to the current value of a sequence of values that define a roast profile. To access earlier or later values one can apply a shift value. For example, while "Y2" returns the current bean temperature (BT), "Y2[-1]" returns the previous BT temperature and "Y2[-2]" the one before that. Formulas used in the Plotter are applied in sequence to all values, thus there "Y2" points to the current BT temperature processed, "Y2[-1]" the previous BT temperature processed and "Y2[+1]" the next BT temperature to be processed. A positive shift is only available in the Plotter, obviously not during recording. |
+
| Example | +Description | +
|---|---|
| t[+1] | +Time one index ahead (plotter only) | +
| t[-3] | +Time three indexes delayed | +
| Y1[-2] | +ET value delayed by 2 indexes | +
| Y2[+1] | +BT value index advanced by one index (plotter only) | +
| B4[-6] | +ExtraBackground #1-B delayed 6 indexes | +
| B5[+2] | +ExtraBackground #2-A advanced 2 indexes (plotter only) | +
| R1[-2] | +ET rate of rise delayed two indexes | +
| Symbol | +Description | +
|---|---|
| t, b, Y<n>, B<n> and R<n> | +Previously recorded data assigned to the symbolic variables t, b, Y<n>, B<n> and R<n> can also directly accessed by index. "Y2{0}" evaluates to the first recorded bean temperature (BT) and "Y2{CHARGE}" to the bean temperature at CHARGE. Additionally, the symbolic variable b can be used to access the recording time at a certain index of the background profile. Thus "b{CHARGE}" returns the recording time at CHARGE of the background profile. | +
| Symbol | +Description | +
|---|---|
| k | +Scaling factor from RoR to Temp axis. The range of the temperature scale divided by the range of the delta scale. | +
| o | +Offset from RoR to Temp axis. | +
| Note: RoR values r can be scaled to the temperature axis using a linear approximation of the form "r*k + o". As the variables k and o depend on the actual axis settings which can be changed by the user without triggering a recomputation, those variable are less useful for use in a recording, but useful in the Plotter to plot w.r.t. the RoR y-axis instead of the temperature y-axis. | +
| Symbol | +Description | +
|---|---|
| CHARGE, DRY, FCs, FCe, SCs, SCe, DROP | +Index of the corresponding event of the profile to retrieve time and values from the corresponding data structures. Evaluates to -1 if not set. | +
| bCHARGE, bDRY, bFCs, bFCe, bSCs, bSCe, bDROP | +Index of the corresponding event of the background profile to retrieve time and values from the corresponding data structures. Evaluates to -1 if not set. | +
| + | + |
| dCHARGE, dDRY, dFCs, dFCe, dSCs, dSCe, dDROP | +Time distance in seconds after the corresponding event. Thus dCHARGE is bound to the current roast time (after CHARGE) in seconds while t is bound to the time in seconds from the start of the recording. | +
| Symbol | +Description | +
|---|---|
| AUCbase | +AUC base temperature (could be from the selected event, if set) | +
| AUCtarget | +AUC target value (could be from the background profile, if set) | +
| AUCvalue | +the current AUC value. -1 if none available. | +
| Symbol | +Description | +
|---|---|
| pDRY | +Prediction of the time distance to the DRY event based on the current RoR. Evaluates to -1 on negative RoR and to 0 if the DRY event is already set. | +
| pFCs | +Same as pDRY, just for the FCs event. | +
| Note: The same rules as for the corresponding PhasesLCDs apply to pDRY and pFCs: If there is no background profile the DRY or FCs bean temperature used for the prediction is taken from the Config>Phases setup. If there is a background profile and there is DRY or FCs event in the background profile, the DRY or FCs bean temperature used for the prediction is taken from the background profile. Exception to the above for DRY only: if AutoDRY is checked the DRY temperature used for the prediction is taken from the Config>Phases setup. This does not apply to FCs and AutoFCs. The prediction value is the calculated time in seconds to reach the DRY or FCs temperature. |
+
| Symbol | +Description | +
|---|---|
| aTMP | +ambient temperature (default 0) | +
| aHUM | +ambient humidity (default 0) | +
| aPRE | +ambient pressure (default 0) | +
| Note: The data is (re-)sampled some seconds after the start of recording | +
| Symbol | +Description | +
|---|---|
| WEIGHTin | +batch size (g) | +
| MOISTUREin | +green moisture (%) | +
| TEMPunit | +temperature unit (Celsius: 0, Fahrenheit: 1) | +
| Expression | +Description | +
|---|---|
| (<true-expr> if <cond> else <false-expr>) | +Conditional. Evaluates to the value of the expression <true-expr> if the condition <cond> holds, otherwise to the value of the expression <false-expr>. The rules of Python are applied to decide if a value holds or not. Thus the boolean values "True" and "False" have the obvious semantic. Any number unequal to 0 evaluates to True and 0 evaluates to False. The value "None" is also evaluated to False. | +
| Formula | +Description | +
|---|---|
| abs(x) | +Return the absolute value of x. | +
| acos(x) | +Return the arc cosine (measured in radians) of x. | +
| asin(x) | +Return the arc sine (measured in radians) of x. | +
| atan(x) | +Return the arc tangent (measured in radians) of x. | +
| cos(x) | +Return the cosine of x (measured in radians). | +
| degrees(x) | +Convert angle x from radians to degrees. | +
| exp(x) | +Return e raised to the power of x. | +
| log(x[, base]) | +Return the logarithm of x to the given base. | +
| min(x1,...,xn) | +Return the minimum of the given values. | +
| max(x1,...,xn) | +Return the maximum of the given values. | +
| pow(x, y) | +Return x**y (x to the power of y). | +
| radians(x) | +Convert angle x from degrees to radians. | +
| sin(x) | +Return the sine of x (measured in radians). | +
| sqrt(x) | +Return the square root of x. | +
| tan(x) | +Return the tangent of x (measured in radians). | +
| bit(n,x) | +Return 1 if the bit n of value x (interpreted as integer) is set, otherwise 0. | +
| Symbol | +Value | +
|---|---|
| e | +2.71828182845904 | +
| pi | +3.14159265358979 | +
| Note: This section applies only to the Plotter Using math formulas in the plotter also allows to use the symbolic variables P and F (see Signals, Symbolic Assignments and the Plotter). |
+
| Symbol | +Description | +
|---|---|
| P1...P9 | +The variables P1,..,P9 represent the results from plot #1,..,#9. You can perform calculations in a later plot on variables of an earlier plot. That way, the plot variables P1,..,P9 allow the cascading or intermediate results. For example, plot #3 can refer to the results of plot 1 using the variable P1. | +
| F1...F9 | +F1 refers to the previous result of the actual formula to realize a feedback loop. This is useful in filter designs. Similarly, F2 refers to the second previous result etc. | +
| The Transposer allows to map the current profile w.r.t. the time and temperature axis by setting targets time and temperature at major events like yellow point (DRY END) or first crack (FC START) or for time transformations also by target phases duration. Temperature transformation are only applied to the bean temperature (BT) curve while time transformations are applied to the whole profile. Three different mapping methods are available to compute from the current profile and the given targets a resulting profile. The linear and quadratic mappings are continuous functions while the discrete option is defined stepwise between the given source/target pairs and extended at the borders Pressing the "Apply" button applies the current computed mapping to the loaded profile for inspection. "Reset" returns to the original profile shape. Leaving the Transposer with "OK" applies the current mapping to the profile. Leaving the Transposer with "Cancel" returns to the unchanged initially loaded profile. |
-
| You might want to re-roast a profile, but extended/restricted to a total length of 10:00. Load the profile and start the Transposer under Tools. Enter our target roast time of "10:00" minutes into the target DROP field under Time and select "linear" as mapping. Check the resulting times of the main events in the time tables last row, press "Apply" to view the transposed profile in the graph. If you are happy with the result, press "OK" and save the newly generated transposed profile such that you can use it as a template for future roasts. |
-
| Transpose temperature readings from your smaller machine to your larger machine assuming on your larger machine the DRY and FC START events happen at different temperatures than on your smaller one. Load the profile recorded on the smaller machine and open the Transposer. Select the linear mapping and put the DRY and FC START target temperatures as observed on your larger machine into the into the corresponding fields under BT. Underneath the table you see the calculated symbolic formula that can be copy-pasted into the BT symbolic formula under Config >> Devices to adjust the computed mapping automatically while roasting on your smaller machine to see the temperature reading as you expect them on the larger machine. |
-
| The Transposer allows to map the current profile w.r.t. the time and temperature axis by setting targets time and temperature at major events like yellow point (DRY END) or first crack (FC START) or for time transformations also by target phases duration. Temperature transformation are only applied to the bean temperature (BT) curve while time transformations are applied to the whole profile. Three different mapping methods are available to compute from the current profile and the given targets a resulting profile. The linear and quadratic mappings are continuous functions while the discrete option is defined stepwise between the given source/target pairs and extended at the borders Pressing the "Apply" button applies the current computed mapping to the loaded profile for inspection. "Reset" returns to the original profile shape. Leaving the Transposer with "OK" applies the current mapping to the profile. Leaving the Transposer with "Cancel" returns to the unchanged initially loaded profile. |
+
| You might want to re-roast a profile, but extended/restricted to a total length of 10:00. Load the profile and start the Transposer under Tools. Enter our target roast time of "10:00" minutes into the target DROP field under Time and select "linear" as mapping. Check the resulting times of the main events in the time tables last row, press "Apply" to view the transposed profile in the graph. If you are happy with the result, press "OK" and save the newly generated transposed profile such that you can use it as a template for future roasts. |
+
| Transpose temperature readings from your smaller machine to your larger machine assuming on your larger machine the DRY and FC START events happen at different temperatures than on your smaller one. Load the profile recorded on the smaller machine and open the Transposer. Select the linear mapping and put the DRY and FC START target temperatures as observed on your larger machine into the into the corresponding fields under BT. Underneath the table you see the calculated symbolic formula that can be copy-pasted into the BT symbolic formula under Config >> Devices to adjust the computed mapping automatically while roasting on your smaller machine to see the temperature reading as you expect them on the larger machine. |
+
;; ;; ,,