![\"232key](\"https:\/\/www.smartlux.com\/232keypro\/wp-content\/uploads\/sites\/5\/2020\/06\/232key-Pro-Data-Flow.png\")
<\/p>\n<\/p>\n
232key Pro works with data strings or “lines of data”. A line is created every time the Terminator<\/strong><\/a> character is found in the stream of bytes received from your device (or when no additional bytes have been received for the duration of the Timeout<\/strong><\/a>, if set).<\/p>\n Next, 232key Pro attempts to match a regular expression (regex)<\/a> in each line. The results of this match are made available to your C# script in the variables<\/a> described below.<\/p>\n Your script runs every time a match is found. It can transform this data in any way you want using the C# language. At he end of your script, return<\/strong> a string that 232key should type, e.g:<\/p>\n This is the default script in 232keyPro. It simply takes the value<\/strong><\/span> variable (see below) and adds a new line character<\/span> (which will be transformed into the ENTER key). Note:<\/strong> The Encoding<\/strong> set under Settings > General Settings<\/strong> is used when the bytes received from your device are first converted to a string.<\/p>\n <\/a><\/p>\n Tip:<\/strong> You can use the C# String.Trim method<\/a> to trim extra white spaces captured by the regex. Example:<\/p>\n For further formatting, please see NumberFormatter.Format<\/a>\u00a0below.<\/p>\n<\/div>\n Tip:<\/strong> If you’d rather parse all data in your script instead of dealing with regular expressions, you can set the Device<\/strong> in the Input<\/strong> tab<\/a> to “Generic text device<\/em>“. This will use a regex which matches all characters except for line feed and carriage return. If you want those as well, change the regex to “([\\s\\S]+)” (without the quotation marks). All data sent from the connected device will then be available in the value<\/strong> string.<\/span><\/p>\n<\/div>\n Using the ([\\s\\S]+) regex, the same input as in the example above would look like this in the Event Log<\/strong>, showing that all data sent by the scale has been matched: Other than using regular C# code, you can call the following functions from your script to simplify common tasks. This function trims white spaces and removes leading zeros. The decimal separator can be set to a dot or comma.<\/p>\n Parameters<\/strong><\/p>\n Returns<\/strong><\/p>\n String<\/strong>: Formatted string or original string if number conversion fails.<\/p>\n Formats captured data as number with a comma as the decimal separator and returns it to 232key Pro for output.<\/p>\n For your convenience, the following constants are available to your script:<\/p>\n You can define any variable you want in your script*, but the variable will be re-initialized every time the script runs, which is every time a line of data is processed. There’s currently no way to avoid if we also want to use extremely fast compiled scripts.<\/p>\n To maintain state between script executions, the following arrays with 10 elements are available:<\/p>\n The variables are maintained even when the script is stopped and restarted. However, they are lost when the program is closed.<\/p>\n *Note:<\/strong> You cannot use reserved keywords<\/a> or the following names for your own (temporary) variables: allMatches, Bools, Decimals, Doubles, ESC, firstMatch, Ints, match (alias for value), Strings, value.<\/p>\n Note:<\/strong> The dollar sign ($) is not typed, it means that the string literal following it may contain {interpolated expressions}<\/a>. Instead, you could also write:<\/p>\n Example output from a weighing scale:<\/strong><\/p>\n Tip:<\/strong> Wondering where the blank spaces in the output are coming from? Except for the one we’ve explicitly added, they were already present in the value<\/strong> variable as the regex defined for this device had captured them.<\/p>\n <\/a><\/p>\n You can easily add the current date and time using DateTime.Now.ToString()<\/a>. A comprehensive list of format specifiers can be found here<\/a>.<\/p>\n Note:<\/strong> 232key Pro uses the invariant culture.<\/p>\n Types the current date (+TAB) and the current time (+TAB) ahead of the content of the value variable and then presses the ENTER key.<\/p>\n Note:<\/strong> The string is broken up into two lines for readability. You could also write the expression in one line:<\/p>\n Example output from a weighing scale<\/strong><\/p>\n <\/a><\/p>\n There are currently two ways to add characters which 232key Pro will then convert to keyboard events.<\/p>\n A keyboard event is created for each character in the string returned from your script. The Unicode flag is set for all characters with the exception of tab (\\t) and line feed (\\n, translated to the ENTER key), which means that you don’t have to worry about keyboard layouts and modifiers.<\/p>\n Types “\u4e2d\u9593\u503c: ” (average) in front of the content of the value variable and then presses the ENTER key.<\/p>\n Example output from a weighing scale<\/strong><\/p>\n <\/a><\/p>\n To type non-alphanumeric keys and key combinations, set the Output Method<\/strong> in the Settings<\/strong> tab to GIDEI<\/strong> and use one of the GIDEI escape sequences described below.<\/p>\n The keys listed below<\/a> are currently supported.<\/p>\n Note:<\/strong> Outside of GIDEI escape sequences, all characters are supported just like in the default output mode! We recommend using GIDEI aliases only for non-printable keys and key combinations.<\/p>\n Detailed information on GIDEI (also implemented as Windows SerialKeys up to XP) can be found in this document<\/a>.<\/p>\n GIDEI support in 232key is currently incomplete and has to be considered experimental.<\/p>\n Start the escape sequence with the ESC character (ASCII 27), followed by one key name<\/a> and a period (ASCII 46). White spaces are optional: Presses the DEL key ahead of the content of the value<\/strong> variable, then TAB twice and finally ENTER. Each GIDEI escape sequence is shown in a different color.<\/p>\n 232key currently supports the combine<\/strong> command to create key combinations.<\/p>\n A key combination consists of the escape character (ASCII 27), the combine<\/strong> command and the key names<\/a>, separated by commas. It ends with a period (ASCII 46): Presses Ctrl + F<\/span> and then types the content of the value<\/strong> variable. <\/p>\n","protected":false},"excerpt":{"rendered":"return value<\/span>+'\\n<\/span>';<\/code><\/pre>\n
\n<\/a><\/p>\nVariables with captured data<\/h2>\n
\n
\n![\"content](\"https:\/\/www.smartlux.com\/232keypro\/wp-content\/uploads\/sites\/5\/2020\/06\/content-of-first-capturing-group-highlighted-in-event-log.png\")
The regex associated with this device profile captures the first number it encounters in each line (in this case, the weight, e.g. \u00a0\u00a0\u00a0\u00a08.738<\/span>). Your script would run once for every line and the value<\/strong> variable would contain the following values:<\/li>\n\n
\nreturn value.Trim()+'\\n';<\/code><\/pre>\n\n
\n
\n![\"matching](\"https:\/\/www.smartlux.com\/232keypro\/wp-content\/uploads\/sites\/5\/2020\/06\/matching-all-data-sent-from-a-scale.png\")
<\/p>\nFunctions<\/h2>\n
\n<\/a><\/p>\nNumberFormatter.Format – formats a string as a number<\/h3>\n
string Format(string capturedString, bool useComma, NumberStyles numberStyles)<\/code><\/p>\n\n
Script example<\/strong><\/h4>\n
return NumberFormatter.Format(value, true, NumberStyles.Number);<\/code><\/pre>\nConstants<\/h2>\n
\n
User variables<\/h2>\n
\n
Script example<\/strong><\/h4>\n
Ints[0]++; \/\/Increase by one\r\nreturn $\"{Ints[0]}: {value}\\n\";<\/code><\/pre>\nreturn Ints[0]+\": \" +value+'\\n';<\/code><\/pre>\n1: 8.234\r\n2: 2.686\r\n3: 26.740<\/pre>\n
Adding the date and time<\/h2>\n
Script example<\/strong><\/h4>\n
return $\"{DateTime.Now.ToString(\"yyyy-mm-dd\")}\\t\"\r\n+$\"{DateTime.Now.ToString(\"HH:mm:ss\")}\\t{value}\";<\/code><\/pre>\nreturn $\"{DateTime.Now.ToString(\"yyyy-mm-dd\")}\\t{DateTime.Now.ToString(\"HH:mm:ss\")}\\t{value}\";<\/code><\/pre>\n022-26-07 13:26:35 123.45 <\/span><\/span><\/pre>\nAdding characters<\/h2>\n
Using the default output settings<\/h3>\n
Script example<\/strong><\/h4>\n
return $\"\u4e2d\u9593\u503c: {value}\\n\";<\/code><\/pre>\n\u4e2d\u9593\u503c:\u00a0 \u00a0 \u00a0 \u00a08.738<\/span><\/span><\/pre>\nUsing GIDEI<\/h3>\n
Individual keys<\/h4>\n
\nESC Keyname .<\/code><\/p>\nGIDEI script example with multiple individual keys<\/h4>\n
return $\"{ESC}delete.<\/span>{value}{ESC}tab.<\/span>{ESC}tab.<\/span>{ESC}enter.<\/span>\";<\/code><\/pre>\nKey combinations<\/h4>\n
\nESC , combine [ , Keyname1 ] [ , Keyname2 ] [, Keyname3 ] [ , etc] .<\/code><\/p>\nGIDEI script example with key combinations<\/h4>\n
return $\"{ESC}, combine, control, f.<\/span>{value}\";<\/code><\/pre>\n
\n<\/a><\/p>\nCurrently supported GIDEI key names<\/h4>\n
\n\n
\n GIDEI Key Name<\/th>\n Description<\/th>\n<\/tr>\n \n 0…9<\/td>\n Keys 0 to 9<\/td>\n<\/tr>\n \n A…Z<\/td>\n Keys A to Z<\/td>\n<\/tr>\n \n alt<\/td>\n ALT key<\/td>\n<\/tr>\n \n altgr<\/td>\n Right ALT key<\/td>\n<\/tr>\n \n backspace
\nbspace<\/td>\nBACKSPACE key<\/td>\n<\/tr>\n \n capslock<\/td>\n CAPS LOCK key<\/td>\n<\/tr>\n \n control
\nctrl<\/td>\nLeft CONTROL key<\/td>\n<\/tr>\n \n enter<\/td>\n ENTER key<\/td>\n<\/tr>\n \n f1\u2026f24<\/td>\n F1\u2026F24 function keys<\/td>\n<\/tr>\n \n del
\ndelete<\/td>\nDEL key<\/td>\n<\/tr>\n \n divide<\/td>\n Numpad DIVIDE key (\/)<\/td>\n<\/tr>\n \n down<\/td>\n DOWN ARROW key<\/td>\n<\/tr>\n \n end<\/td>\n END key<\/td>\n<\/tr>\n \n escape<\/td>\n ESC key<\/td>\n<\/tr>\n \n home<\/td>\n HOME key<\/td>\n<\/tr>\n \n ins
\ninsert<\/td>\nINSERT key<\/td>\n<\/tr>\n \n kp*
\nkpstar<\/td>\nNumpad MULTIPLY key (*)<\/td>\n<\/tr>\n \n kp+
\nkpplus<\/td>\nNumpad ADD key (+)<\/td>\n<\/tr>\n \n kp-
\nkpminus<\/td>\nNumpad SUBTRACT key (-)<\/td>\n<\/tr>\n \n kp\/
\nkpdivide
\nkpslash<\/td>\nNumpad DIVIDE key (\/)<\/td>\n<\/tr>\n \n kp0…kp9<\/td>\n Numpad 0 to 9 keys<\/td>\n<\/tr>\n \n kpdp<\/td>\n Numpad DECIMAL POINT key<\/td>\n<\/tr>\n \n lcontrol
\nlctrl<\/td>\nLeft CONTROL key
\n(same as control)<\/td>\n<\/tr>\n\n left<\/td>\n LEFT ARROW key<\/td>\n<\/tr>\n \n lshift<\/td>\n Left SHIFT key<\/td>\n<\/tr>\n \n menu<\/td>\n ALT key
\n(same as alt)<\/td>\n<\/tr>\n\n next<\/td>\n PAGE DOWN key<\/td>\n<\/tr>\n \n numlock<\/td>\n Numpad NUM LOCK key<\/td>\n<\/tr>\n \n prior<\/td>\n PAGE UP key<\/td>\n<\/tr>\n \n rcontrol
\nrctrl<\/td>\nRight CONTROL key<\/td>\n<\/tr>\n \n return<\/td>\n ENTER key
\n(same as enter)<\/td>\n<\/tr>\n\n right<\/td>\n RIGHT ARROW key<\/td>\n<\/tr>\n \n rshift<\/td>\n Right SHIFT key<\/td>\n<\/tr>\n \n tab<\/td>\n TAB key<\/td>\n<\/tr>\n \n up<\/td>\n UP ARROW key<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n