SESSION PARAMETERS- TELNET

Session parameters:
ANSWERBACK

Response to ENQ request from server.

Valid values:
[CR] – emulation of Enter,
[TAB] – emulation of tabs,
[SN] – serial number,
[0xB] – set of bytes, for example [0x01] [0x02] [0x03],
[PAUSEx] – delay in x (ms),
[KEYCODE] – key,
‘TEXT’ – string,

Example: ANSWERBACK: ‘HELLO’

 

AUTOLOGIN_CILY_ON_CONNECT

The set (list) of commands and data transmitted to the server is executed once when a new session starts (another interpretation of the autologin).

Format: AUTOLOGIN_CILY_ON_CONNECT (‘string’): command_1 command_n

Valid command values:
[CR] – emulation of Enter,
[TAB] – emulation of tabs,
[SN] – serial number,
[0xB] – set of bytes,
[PAUSEx] – delay in x (ms),
[KEYCODE] – key,
‘TEXT’ – text.

Example:
Having connected to the server, pause for 1 second, transfer the login, tab, password, Enter, wait 1 second, then send the terminal serial number: AUTOLOGIN_CILY_ON_CONNECT: [PAUSE1000] ‘mylogin’ [TAB] ‘pass’ [CR] [PAUSE1000] [SN]

AUTOSTART

The name of the session that will start automatically when the program launches. This parameter may be empty.

Example:
(automatically start a TEST session)
AUTOSTART: TEST

CHARSET_NAME

Server side coding. Default parameter value or if empty: UTF-8.

Possible parameter values:
https://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html

Frequently used values: UTF-8, koi8-r, windows-1251.

Example: CHARSET_NAME: koi8-r

 

CONNECT_TIMEOUT

Server response expectation time (in seconds). After the timer expires, a server unavailable error is displayed.

Example: 30

KEEPALIVE

This function enables the periodic sending of the byte sequence specified in the specific parameter to the server in order to keep the network stack active.

KEEPALIVE: [T, 0xB]

Т – sending period (in seconds). Starts from the sending time of previous package sent to the server.
0xB – set of bytes, for example [0x01] [0x02] [0x03]

The example where EMC sends the “null” value to the server (0x00) every 30 seconds: KEEPALIVE: [30.0 × 00]

PREVENT_SLEEP

This parameter determines the behavior of the screen sleep mode.

Possible values:
true – always on,
false – according to the sleep settings of the OS.

Example: PREVENT_SLEEP: true

SESSION

Use the SESSION parameter to create each new session.

 

Syntax for TELNET:

SESSION_TELNET: host: port session_name

 

Syntax for SSH:

SESSION_SSH: host: port session_name ‘user’ ‘password’

 

Where:

host – ip-address or DN-name of the server,

port – TCP port,

session_name – session name (displayed in the list of available sessions and  used for creating override *).

‘user’ – SSH username

‘Password’ – SSH user password

 

*Override is a set of parameters that are executed exclusively in the specified session.

 

Example 1: Declare two sessions My_Telnet_WMS and My_SSH_WMS

SESSION: od.sytecs.com.ua:2323 My_Telnet_WMS
SESSION: 127.0.0.1:22 MY LOCAL My_SSH_WMS ‘admin’ ‘pass’

 

Example 2: The example of a config file with override, where different font sizes will be used in two separate sessions:

[My_Telnet_WMS]
TEXT_SIZE: 20

[My_SSH_WMS]
TEXT_SIZE: 40

TERMINAL_COL_MARGIN

Margin width between columns in relative units (between letters in a column), default value – 0.

Example: TERMINAL_COL_MARGIN: 3

TERMINAL_ROW_MARGIN

Margin width between lines in relative units (between letters in a line), default value – 0.

Example: TERMINAL_ROW_MARGIN: 3

TERMINAL_TYPE

Determines emulation type expected by the server.

Possible values:
VT220, VT100

Default value – VT220.

Example: TERMINAL_TYPE: VT100

Appearance:
COLOR_SHEMA

This parameter determines the color of on-screen elements (in HEX 16Bit format).

Format: COLOR_SHEMA: BACKGROUND_COLOR, TEXT_COLOR, CURSOR_COLOR
If not specified, the parameter takes on the following value: # 000000, # 33FF00, # 33FF00

Example: COLOR_SHEMA: # 000000, # 33FF00, # 33FF00

CURSOR_BLINKING

This parameter defines the cursor behavior as follows:
true – cursor blinks at a frequency of 1Hz
false – cursor has a fixed text color

Example: CURSOR_BLINKING: false

FULL_SCREEN_MODE

Determines the on-screen content.

Possible values:
true – full screen mode activation (the OS dashboard is hidden),
false – launches in a standard OS window.

Example: FULL_SCREEN_MODE: true

SESSION_SCREEN_ORIENTATION

Determines the orientation (rotation) of the screen

Valid values:
A – screen rotation in this session is allowed,
P – fix in portrait orientation,
L – fix in landscape orientation (enable auto-rotation in OS),
L2 – fix in inverted landscape orientation (enable auto-rotation in OS),
Default value or if not specified: P

Example: SESSION_SCREEN_ORIENTATION: L2

SHOW_WLAN_INDICATOR

Determines the behavior of the indicator (signal strength).

Possible values:
off – not displayed,
on – always displayed,
low – displayed only if signal is unavailable.

Example: SHOW_WLAN_INDICATOR: low

TEXT_SIZE

Determines the terminal font size.

Possible values:
Empty – ont size takes the default value of 28,
Number – fixed font size,
AUTO – font size is set automatically in accordance with the parameter rules,
TEXT_AUTOSIZE_X_UP_TO and TEXT_AUTOSIZE_Y_UP_TO

TEXT_AUTOSIZE_X_UP_TO

This parameter determines the limit of the text stretching to the right (X coordinate). It is specified in % of the full screen width.

Possible values:
NUM – a number corresponds to % of the screen on which the text is displayed. Values range from 10 to 200. 100 – if the parameter is not specified.
KEYBOARD – stretching is performed towards the keyboard on the right, if there is one.

When stretching is enabled, the position of the text down the lines is tracked in any case. That is, stretching to the right is limited by the bottom edge of the screen.

This parameter has no effect in case of VIRTUAL_KEYBOARD_STICK_TO AUTO and FONT_SIZE fixed values are set

Example: TEXT_AUTOSIZE_X_UP_TO: KEYBOARD

TEXT_AUTOSIZE_Y_UP_TO

This parameter determines the limit of the text downward stretching (Y coordinate). It is specified in % of the full screen height.

Possible values:
NUM – a number that corresponds to % of the screen on which the text is displayed. Values range from 10 to 200. 100 – if the parameter is not specified.
KEYBOARD – in this case, stretching is performed towards the bottom of the keyboard, if there is one.

When stretching is enabled, the position of the text along the columns is tracked in any case. That is, stretching to the right is limited by the right edge of the screen.

This parameter has no effect in case of VIRTUAL_KEYBOARD_STICK_TO AUTO and FONT_SIZE fixed values are set.

Example: TEXT_AUTOSIZE_Y_UP_TO: 90

Barcode Scanner:
BARCODE_PREFIX

Prefix, that is set before the value of the scanned barcode.

Valid values:
null – empty (no prefix is ​​transmitted),
[CR] – emulation of Enter,
[TAB] – emulation of tabs,
[SN] – serial number,
[0xB] – a set of bytes, for example [0x01] [0x02] [0x03],
[PAUSEx] – delay in x (ms),
[KEYCODE] – key,
‘TEXT’ – string.

A sequence of several values is allowed.

Example: BARCODE_PREFIX: ‘*’

BARCODE_TERMINATOR

Suffix, that is set after scanning the barcode.

Valid values:
null – empty (no suffix is ​​transmitted),
[CR] – emulation of Enter,
[TAB] – emulation of tabs,
[SN] – serial number,
[0xB] – a set of bytes, for example [0x01] [0x02] [0x03],
[PAUSEx] – delay in x (ms),
[KEYCODE] – key,
‘TEXT’ – string.

A sequence of several values ​​is allowed.

Example: BARCODE_TERMINATOR: [TAB] [PAUSE500] [CR]

BARCODE_TO_COMMAND

The function that converts the scanned barcode into a command transmitted to the server. Designated for automating menu navigation and operations using barcodes as input sources.

Format: BARCODE_TO_COMMAND (‘CHAR’): command_1 command_n

‘TEXT’ is a trigger text contained in the barcode (for example: ‘return’),

{command} – a single command or a sequence of commands.

If the scanner is connected as a keyboard emulator, TEXT parameter has limitations: use at least one Latin letter in lower case.

Valid values of command:
null – empty (no suffix is ​​transmitted),
[CR] – emulation of Enter,
[TAB] – emulation of tabs,
[SN] – serial number,
[0xB] – a set of bytes, for example [0x01] [0x02] [0x03],
[PAUSEx] – delay in x (ms),
[KEYCODE] – key,
‘TEXT’ – string.

Example:
If the character t is entered, then for emulating the transmission of the CR value to the server use:
BARCODE_TO_COMMAND (‘t’): [CR]

 

BARCODE_TYPE

Valid barcode encodings (those not in the list will not be scanned).

Valid values: [ALL] – all types (no other parameters are provided in this version).

Example: BARCODE_TYPE: [ALL]

BARCODE_WEIGHT_RULE

This parameter sets the rules for processing barcodes that have a specific P prefix:

BARCODE_WEIGHT_RULE (‘P’)

 

The following processing rules are available:

  1. Adding a prefix

APPEND_STRING (‘Value’)
where Value is a text.

Example: the scanned barcode 2000000345 is converted to 000002000000345

BARCODE_WEIGHT_RULE (‘2’): APPEND_STRING (‘00000’)

 

  1. Separation of a part of the code (for example, weight)

EXTRACT_WEIGHT_BY_MASK (‘Mask’)

where Mask is the mask format:
* – any character
A – article
K – weight in kg
G – weight in grams

Example mask: ’21AAAAAKKGGG’

Example: the weight part 00.888 will be removed from the scanned weight barcode 2912345600888 and further transmitted to the server:

BARCODE_WEIGHT_RULE (‘2’): EXTRACT_WEIGHT_BY_MASK (‘2 * AAAAAKKGGG’)

TRIGGER_TIMEOUT

Timer in seconds, that sets the scanner activation time for a virtual trigger (keyboard key or floating scan key). If not specified, then the value is 5 sec.

Example: TRIGGER_TIMEOUT: 5

Virtual keyboard:
VIRTUAL_KEYBOARD

Enabling the virtual keyboard. Keyboards are toggled by swipe (if multiple keyboards are enabled).

Possible values:

[ALL]

Demonstration mode for all existing types of keyboards. When active, the keyboard name appears in the middle of the screen.

[name]

Specify the name of the virtual keyboard to be used. You can enable several keyboards at once by separating their names with a space (see example below).

Example:
Enable functional, numeric and ASCII keyboards:
VIRTUAL_KEYBOARD: [FN] [NUM] [ASCII]

VIRTUAL_KEYBOARD_HEIGHT

The parameter sets the keyboard height in % relative to the full screen height (this parameter is effective only in the portrait orientation mode).

Default value: 35

Example: VIRTUAL_KEYBOARD_HEIGHT: 35

VIRTUAL_KEYBOARD_LOCK

This parameter locks the keypad on the screen.

Possible values:
true – virtual keyboard is fixed and not hidden,
false – virtual keyboard gets hidden by pressing a key.

Example:
Hide the keyboard and then display it by clicking on the icon:
VIRTUAL_KEYBOARD_LOCK: false

VIRTUAL_KEYBOARD_STICK_TO

This parameter determines the position of a keyboard in landscape orientation (L, L2).

Possible values:
BOTTOM – bottom,
RIGHT – right (default value),
MANUAL – pressing the keyboard icon for more than 3 seconds alters the keyboard position from BOTTOM to RIGHT and vice versa in landscape orientation L, L2. This is the default value for the given parameter.

Example: VIRTUAL_KEYBOARD_STICK_TO: MANUAL

VIRTUAL_KEYBOARD_TRANSPARENCY

The parameter determines the degree of keyboard transparency in %.

Default value: 80

Example: VIRTUAL_KEYBOARD_TRANSPARENCY: 80

VIRTUAL_KEYBOARD_WIDTH

This parameter sets the width of the keyboard in % relative to the full width of the screen (this parameter is effective only in landscape orientation).

Default value: 35

Example: VIRTUAL_KEYBOARD_WIDTH: 35

Keyboard macros:
KEYCODE

Keyboard reassignments (macros) allow increasing the operator’s ergonomics. Reassignments work only for the hardware buttons of the device.

A macro for any given key is a one-line entry in the following format:
keyName (my description): {command}

keyName (my description) – The system code and the assigned friendly name (my description). The system code can be found by running the KEY SCANCODES program from the menu. This program displays the keyName values ​​of the keys that are pressed.

Example: KEYCODE_F1 (F1 button)

{command} – a sequence of calls that are transmitted to the server.

Valid values:
null – empty (no suffix is ​​transmitted),
[CR] – emulation of Enter,
[ESC] – escape,
[TAB] – emulation of tabs,
[SN] – serial number,
[0xB] – a set of bytes, for example [0x01] [0x02] [0x03],
[PAUSEx] – delay in x (ms),
[KEYCODE] – key,
‘TEXT’ – string.

Examples:
By pressing F1, send the key code 3 to the server:
KEYCODE_F1 (F1): [KEYCODE_3]

By pressing F1, send TAB to the server (corresponds to 09 in ASCII tables, see appendix A):
KEYCODE_F1 (F1): [0x09]

By pressing F1, send the TEXT line to the server:
KEYCODE_F1 (F1): ‘TEXT’

By pressing F1, send the TAB command to the server (pressing the TAB key is emulated):
KEYCODE_F1 (F1): [TAB]

Commands can also be transmitted as bytes, that is, the two entries below are equivalent:
KEYCODE_F1 (F1): [TAB]
KEYCODE_F1 (F1): [0x09]

Macros can be assembled in a sequence. Sequences should be separated by spaces in order to make input easier. Absence of spaces is not considered as error. The macro will not be executed if some element has an incorrect entry inside. The number of lines is unlimited.

By pressing F1, transfer login, tabulation, password, Enter (CR), wait 1 sec., Send CR LF:
KEYCODE_F1 (F1): ‘mylogin’ [TAB] ‘pass’ [CR] [PAUSE1000] [0x0D] [0x0]

 

ESC Command Table

Combination Command HEX
Ctrl+A SOH 0x01
Ctrl+B STX 0x02
Ctrl+C ETX 0x03
Ctrl+D EOT 0x04 
Ctrl+E ENQ 0x05 
Ctrl+F ACK 0x06
Ctrl+G BEL 0x07
Ctrl+H BS 0x08
Ctrl+I TAB 0x09
Ctrl+J LF 0x0A
Ctrl+K VT 0x0B
Ctrl+L FF 0x0C
Ctrl+M CR 0x0D
Ctrl+N SO 0x0E
Ctrl+O SI 0x0F
Ctrl+P DLE 0x10
Ctrl+Q DC1 0x11
Ctrl+R DC2 0x12
Ctrl+S DC3 0x13
Ctrl+T DC4 0x14
Ctrl+U NAK 0x15
Ctrl+V SYN 0x16
Ctrl+W ETB 0x17
Ctrl+X CAN 0x18
Ctrl+Y EM 0x19
Ctrl+Z SUB 0x1A
Ctrl+[ ESC 0x1B
Ctrl+\ FS 0x1C
Ctrl+] GS 0x1D
Ctrl+^ RS 0x1E
Ctrl+_ US 0x1F
Ctrl+? DEL 0x7F

 

Special functions:
AUTO_REPLY

Server auto-reply when certain string parameters appear.

Format: AUTO_REPLY (‘string’): command_1 command_n

Valid values of command:
[CR] – emulation of Enter,
[TAB] – emulation of tabs,
[SN] – serial number,
[0xB] – a set of bytes,
[PAUSEx] – delay in x (ms).

Example:
[0x01] [0x02] [0x03],
[PAUSEx] – delay in x (ms),
[KEYCODE] – key,
‘TEXT’ – text.

Example 1:
When the “Terminal:” input field appears on the screen, send the serial number of the terminal along with Enter:
AUTO_REPLY (‘Terminal:’): [SN] [CR]

Example 2:
When the input field “Login:” appears on the screen, wait for 1 s, then transfer the login, tabulation, password, Enter:
AUTO_REPLY (‘Login:’): [PAUSE1000] ‘mylogin’ [TAB] ‘mypass’ [CR] [PAUSE1000] [SN]

CALCULATOR

The “Calculator” function is used to calculate the total weight from the scanned weight codes of one article. Also, it transfers the received amount to the input line.

  1. Activating the function:

CALCULATOR_ENABLE (‘P’): [AUTO] or [KEYCODE_F]
where P is the barcode prefix the calculator is used for,
AUTO – automatic activation of the calculator by prefix,
KEYCODE_F – button code for manual calculator activation by pressing a key.

Example: CALCULATOR_ENABLE (‘2’): [KEYCODE_F3]

 

  1. Setting the weight barcode mask:

CALCULATOR_MASK: ‘Mask’
where Mask is the mask format:
* – any character
A – article,
K – weight in kg,
G – weight in grams.

Example: CALCULATOR_MASK: ‘2 * AAAAAKKGGG’

 

  1. Setting up the function key for confirmation or canceling:

CALCULATOR_CONFIRM_KEY (‘Text’): [KEYCODE_F]
CALCULATOR_CANCEL_KEY (‘Text’): [KEYCODE_F]
where Text is the name of the button that is visible for the user,
KEYCODE_F – action button code.

Example:
CALCULATOR_CONFIRM_KEY (‘F5 OK √’): [KEYCODE_F5]
CALCULATOR_CANCEL_KEY (‘F6 CANCEL X’): [KEYCODE_F6]

 

  1. Setting up the text of the blocking notification when scanning another article (the first scanned article is taken as a template):

CALCULATOR_WARNING_TEXT: ‘Text’
where Text is the warning text to display on the screen.

Example: CALCULATOR_WARNING_TEXT: ‘WRONG PRODUCT!’

 

Complete example:
CALCULATOR_ENABLE (‘2’): [KEYCODE_F3]
CALCULATOR_MASK: ‘2 * AAAAAKKGGG’
CALCULATOR_CONFIRM_KEY (‘F5 OK √’): [KEYCODE_F5]
CALCULATOR_CANCEL_KEY (‘F6 CANCEL X’): [KEYCODE_F6]
CALCULATOR_WARNING_TEXT: ‘WRONG PRODUCT!’

PREVENT_DOUBLE_TAP

Used when the device is experiencing double input when pressing keyboard keys. This feature is seen on the terminals of the manufacturer UROVO.

Possible values:
true – apply,
false – disabled.

Default value: false

Example: PREVENT_DOUBLE_TAP: true

SCANHELPER_HOST

The service address and port for replacing the scanned barcodes with server data.
It is used if, instead of a barcode, the user needs to send a certain value to the Telnet server, which is transmitted by the TCP server.

The format complies with the Scan Helper 1.1 specification:
Server package: <STX> BARCODE <ETX>
Server response: <STX> Value1 | ValueN <ETX>
EMC processes the symbol | like \ n

Example: SCANHELPER_HOST: 10.0.0.100:9000

SCANHELPER_PREFIX

Barcode prefix to be replaced using the Scan Helper service.
It is allowed to enter several prefixes, separating them with a comma.

Example:
SCANHELPER_PREFIX: ‘WH’
Server <STX> Barcode <ETX>
Reply: <STX> VALUE1 | VALUEn <ETX>

 

UPDATE_URL

Link to the http-server where the apk-file of the new version of the EMC application is uploaded.

Example:
By clicking on the link provided as an example you can always download the latest version:
UPDATE_URL: https://sytecs.com.ua/user/emc/com.enterprisemobilityclient.te.apk