4.3 Ingenico Telium OS modem specific commands

Transcription

1 4.3 Ingenico Telium OS modem specific commands Command: return to command mode Syntax : void esc_command (void) 4.4 AT Commands The AT commands are used to: C operational parameters, Establish a communication, Generate specific tests and controls, End a communication or a test in progress. The syntax of an AT command line is as follows: AT <command> <parameters> <CR> <command> : 1 or 2 letters <parameters> : numerical values associated (or not) to modifiers Several commands may be concatenated to form a command line. A command line begins with AT or at and is terminated by a carriage return character (0D Hex). Automatic character format recognition is performed. A command line is processed once the carriage return has been entered. Generally, when all commands of a line have been processed, an OK result code is returned by the modem. When a line command has got an error the ERROR result code is returned. Some commands can be aborted (notably D and A commands). They are aborted if the terminal sends any character while command execution is in progress. In data mode, the modem changes mode by an escape sequence (+++) preceded and followed by a time-out. The change in operational mode is achieved by an escape sequence (+++) or by a specific command (esc_command). The set of commands is described in the Detailed description of AT commands section; the set of registers used is defined in the Description of registers section.

2 4.5 Command mode On initial power up of the terminal, and before using the modem, the modem must be initialised using the Z command. The modem goes into command mode when: It receives an initialisation command Z It receives a hang up command H The link with the called modem has not been achieved After request for monitoring of the receive carrier, it disappears permanently (time exceeds time delay specified in register S10) In command mode, it is possible to: Configure and set-up the modem by writing registers Individually read all the registers Call a party In command mode, it is not possible or prohibited to: Send or receive data 4.6 Dialling operation The dialling command D is used to establish a call with another system, and a remote modem, through the PSTN. Starting with the command line, supplied by the application, the modem independently executes all of the phases linked to call a party. To connect with a remote modem, four main phases are executed automatically: A dialling command D can be followed by one or several modifications in the same command line. n The modifications indicate, to the modem:

3 When to dial a number (time-outs), The number to dial (digits, characters), The method to use (pulsed, DTMF). n Refer to the Detailed description of AT commands section for details concerning the dialling command D and the possible options defined by the modifiers. Modifier Description 0 to 9 Digits used in pulse or DTMF dialling P Pulsed dialing T DTMF dialling Wait for time-out before processing next digit or character The P or T modifiers must be followed by at least one dialling character or digit. The modifier (,) can be repeated consecutively in a dialling chain. However, this procedure is not recommended; it is better to modify the modem parameter values (S8 register). Dialling operation can last several seconds (5 to 60 seconds). The application can request aborting a sequence in progress (phases 1 to 3) by sending any character to the modem. The modem automatically ends the dialling mode and returns to the command mode (automatic exchange line released) when dialling fails At the end of the dialling mode, the modem generates a report (see Modem execution report section). 4.7 Data mode The modem is in data mode when linked with a remote modem. The modem passes to data or line mode at the end of execution, without error, of a dialling request specified by the command line generated by the application. The data mode is used by the application to exchange data with the remote system. Data are sent and received using the standard input/output functions.

4 The escape sequence is mandatory before generating any command to the modem. This must be preceded by a one-second time delay and followed by the same time delay. The +++ characters must be sent within 100 ms. 4.8 Modem execution reports The result can be a numerical value or a string. The selection of the result code is selected by ATV command (ATV0 numerical form, ATV1 verbose form) For easy field maintenance, it is necessary to print and date on the terminal the dialling return code of the modem. Printing or displaying dialling return codes should be possible at operator level. Automatic call management must be compliant with country rules. They must be taken into account by application software and not by the modem 4.9 Dialling report At the end of execution of a dialling command line, the report is returned to the application. Depending on the request specified in ATV command, the report will be numerical or verbose and followed by <CR>. Num String Meaning 0 OK Command correctly executed 1 CONNECT Link between two modems has been successfully established 2 RING Incoming call indication 3 NO CARRIER Call cleared, communication terminated 4 ERROR Syntax error or impossibility for modem to execute command 5 CONNECT 1200 Communication established at 1200 bps

5 5 CONNECT 1200/ARQ Communication established at 1200 bps with error correction 6 NO DIAL TONE Dial tone checking fails 7 BUSY Called number is busy 9 CONNECT 600 Communication established at 600 bps 9 CONNECT 600/ARQ Communication established at 600 bps with error correction 10 CONNECT 2400 Communication established at 2400 bps 10 CONNECT 2400/ARQ Communication established at 2400 bps with error correction 11 CONNECT 4800 Communication established at 4800 bps 11 CONNECT 4800/ARQ Communication established at 4800 bps with error correction 12 CONNECT 9600 Communication established at 9600 bps 12 CONNECT 9600/ARQ Communication established at 9600 bps with error correction 13 CONNECT Communication established at bps 13 CONNECT 14400/ARQ Communication established at bps with error correction 24 CONNECT 7200 Communication established at 7200 bps 24 CONNECT 7200/ARQ Communication established at 7200 bps with error correction 25 CONNECT Communication established at bps 25 CONNECT 12000/ARQ Communication established at bps with error correction

6 4.10 Configuring the modem The modem has also the following features: A ring detector circuit allowing modem to auto-answer A line current detection circuit to indicate an occupied line at the start (line occupied by a subscriber telephone), Synchronous transmission and reception of data Data exchange speeds can be configured via ATFn command or S37 register setting. Error correction and Data compression can be configured via respectively AT\N and AT%C command. Negotiation can be configured via ATNn Choice of data format Data format is 8 bits no parity. Other framing (parity) must be handled at application level Choice and storage of parameters The values contained in registers: Can be replaced completely by the default profile, Can be individually modified There is only one user profile: the factory default. Comma nd Function S Sr =x Write x in address register r Sr? Read address register r &V Read the active configuration parameters

7 Z Reinitialises and use the default configuration 4.13 Multi mode operations EFT30 modem can be programmed to operate in multi-mode to be connected at the highest possible speed. Multi-mode is selected by either S37 register setting or ATF0 command Modems to be used on servers Modems called by EFT30 must have the following requirements: Be compliant with country specifications Be a quality modem with an error rate on artificial line less or equal to 10-6 bit 4.15 Incoming call management CAUTION: a dedicated phone line for the terminal is suggested ( no line sharing with other equipments) In case of line sharing with other devices such as TeleFax machine or computers, user communication will be interrupted by the modem in case of incoming call when automatic answer mode is selected. Prefer using manual answer and care should be taken with rings number before line taking. This feature allows modem to answer to incoming calls. Applications with the help of OS and M2- OS have to manage incoming calls Setting-up the auto-answer mode The auto-answer mode by automatic set-up Select automatic answering by setting-up register S0 with the number of rings (ATS0=x\r). Select manual answering by initialising register S0 to 0 (ATS0=0\r). In that case modem will not take the line automatically; it will be done through application software with an ATA command.

8 Incoming call management (automatic answer) After x rings (x specified in register 0) O/S will take the line and start the modem handshake. When connected, O/S will send the CONNECT string to the application and set-up the event COM_REC_NOT_EMPTY. Application has to take care of incoming string when modem peripheral file is opened, otherwise modem can stay on-line for a while Incoming call management (manual answer) This is the preferred method of handling. When it is ringing, O/S will send the RING string to the application and set-up the event COM_REC_NOT_EMPTY. Application has to take the line by sending an ATA command Modem returns the CONNECT or NO CARRIER message. RING occurs every 5 seconds (this value may change according to country rules) After 5 rings (this value may change according to country rules), modem automatically stops the ringing process and the call is lost Detailed description of AT commands The set of AT commands is used to configure the modem s operational parameters, initiate and terminate a communication. n Command syntax: All of the commands are preceded by the letters AT (upper-case or lower-case accepted) and terminated by a carriage return (0DH) indicating the end of the command line. n Command format: The modem uses the commands formed by one or two letters. Two command formats are identified: a) Command formed by a single letter (upper-case or lower-case accepted) Example ATZ

9 b) Command formed by an ampersand (& code 26H) and a letter Example AT&M0 n Command message parameters: Most of the AT commands are followed by numerical parameters: The parameter is used to: - Enable or disable a function - Select a configuration or operating option - Point and designate a memory position (designation of a register) A COMMAND ATA Function: Take the line when an incoming call is detected Options: Can be aborted, last in line command See Incoming call management 4.18 D COMMAND ATD < dialling string > Function: Used to establish communication through the switched telephone network (PSTN) with another subscriber. Options: The command can be followed by several modifiers specifying the dialling method and the number to be dialled. 1) P option: The number is pulse-dialled.

10 ATDP: numbers to dial (digits 0 to 9) 2) T option: The number is DTMF-dialled. The inter-character time is defined in register S11. Example ATDT number to dial (digits 0..9,#,*) 3) Option, (comma): Requires the modem to wait for a time specified in register S8 (2 seconds as a default) before handling the next character or symbol OR Dial in blind when placed ahead T or P switches after a time specified in register S6 ( 0 second as a default ) Unrecognised characters have a no effect E COMMAND ATEn Function: Disable or enable echo Options: n = 0 disable echo n = 1 enable echo 4.20 F COMMAND ATFn Function: This command allows selection of line modulation

11 Options: n = 0: select multi-mode operation allowing modem to be automatically adapted to the highest possible speed of remote modem n = 1: select V21 n = 4: select V22 n = 5: select V22 BIS n = 6: select V32 BIS 4800 bps n = 7: select V32 BIS 7200 bps n = 8: select V32 BIS 9600 bps n = 9: select V32 BIS bps n = 10: select V32 BIS bps n = 11: select V34 (not available yet) Note: When n is different from zero, single mode is automatically set-up H COMMAND ATHn Function: This command is used for modem line seizure or release. When released, the line is returned, without cut-out (within 10 ms) to the telephone set. If the modem was in data mode, an on-hook request is used to drop the current mode (return to command mode) and the line is switched to the telephone set. Options: n = 0: hang up, clear call n = 1: ensures line seizure by line relay control I COMMAND ATIn Function: This command is used for identification and internal tests.

12 Options: n = 0: product numerical information n = 1: display ROM checksum n = 2: perform ROM checksum test n = 3: product name, revision level and checksum 4.23 N COMMAND ATNn Function: Allows selecting single or multi-mode Options: n = 0: disable automatic handshake and use S37 register n = 1: enable automatic handshake and select multi-mode Notes: default ATN O COMMAND ATO Function: Used to transfer to data mode. Options: Note: This command is necessary to transfer to data mode following an escape +++ sequence or the esc_command S COMMAND ATSr = X

13 Function: ATSr? Used for two basic operations on the registers assigned to the modem: Modification of contents in a register used to configure variable parameters, Consultation of contents in a register Options: 1) Modification of a register: ATSr = X A register is modified by an assignment operation using the = sign Sr: defines a pointer for a specific register whose number is specified by r. The value of r is between 000 and 255. The register number is designated by 3 ASCII digits. X: designates a sequence with 3 ASCII digits which represents the value to be loaded in the register to 255-2) Reading of contents of a register: ATSr? Sr: defines a pointer for the register to be consulted which is designated by r. The value of r is between 000 and 255. The number of the register is designated by 3 ASCII digits. The modem replies to the read request in the form of a message comprising 3 ASCII characters which represent the decimal value of the register: 000 to V COMMAND ATVn Function: Used to select the result code format returned by the modem. Options: n = 0: the result code is supplied in the form of a numerical n = 1: the result code is supplied in the form of a string.

14 Definition of results code (see section covering Modem execution report ). Note: see ATX command, default ATV W COMMAND ATWn Function: Used to select negotiation progress information Options: n = 0: CONNECT reports junction speed and disable extended negotiation message n = 1: CONNECT reports line speed and enables CARRIER and PROTOCOL indications n = 2: CONNECT reports line speed and disable extended negotiation indications Note: See ATX command, default ATW X COMMAND ATXn Function: result code selection and call progress monitoring. Options: n = 0: busy detection disabled, dial tone detection disabled. Only CONNECT is allowed n = 1: busy detection disabled, dial tone detection disabled. Only CONNECT xxx enabled n = 2: busy detection disabled, dial tone detection enabled. Only CONNECT xxx enabled n = 3: busy detection enabled, dial tone detection disabled. Only CONNECT xxx enabled n = 4: busy detection enabled, dial tone detection enabled. Only CONNECT xxx enabled Note: ATX4 as default

15 4.29 Z COMMAND ATZ Function: This command is used to initialise the modem software with the default parameters configuration Note: user profile is the factory default 4.30 & commands &Q COMMAND AT&Qn Function: Use to switch modem to operate in asynchronous or in synchronous mode. Options: n = 0: asynchronous mode selected n = 1: synchronous mode selected n = 2: synchronous mode selected, DTR handling n = 5: asynchronous mode with error correction mode selected Note: AT&Q0 as default &V COMMAND AT&V Function: Used to read active parameters configuration of the modem.

16 Options: No option Note: Each parameter read is represented by 3 ASCII-coded digits: 000 to 255. Parameters are transferred in reply to the application. The reply will take the form of: xxx <CR> xxx <CR> xxx <CR>... xxx <CR> Where <CR> = 0D hex, and xxx represents the 3 ASCII characters of the decimal value of register \ commands \N Error correction command AT\Nn Function: Used to select the error correction level Options: n = 0: disable error correction n = 2: error correction link only (V42 or MNP 4) n = 3: error correction if available n = 4: V42 only n = 5: MNP 4 only Note: Default is \N % commands %C Data compression command AT%Cn

17 Function: Used to select the data compression option Options: n = 0: disable data compression n = 1: enable MNP 5 n = 2: enable V42bis n = 3: enable V42bis and MNP5 under remote negotiation Note: Default is %C commands MS Modulation command Implementation of the "AT+MS=", "AT+MS?" and "AT+MS=?" commands, and support for the specification of asymmetric bit rates for modem transmission and reception. Detailed syntax for the "AT+MS=" command: two syntaxes are defined: "AT+MS=" new syntax: (all fields are optional) AT+MS = <carrier1>, <automode1>, <min_tx_rate1>, <max_tx_rate1>, <min_rx_rate1>, <max_rx_rate1> <carrier1>: string, one of "B103" : Bell 103 "B212" : Bell 212 "V21" : V.21 "V22" : V.22 "V22B" : V.22bis "V22F" : V.22 Fast Connect "V23C" : V.23 "V32" : V.32 "V32B" : V.32bis

18 "V34" : V.34 "V90" : V.90, current role (AT+MS= and AT+MS=? only) "V90C" : V.90, client side "V90S" : V.90, server side "V92" : V.92, current role (AT+MS= and AT+MS=? only) (Netbricks extension) "V92C" : V.92, client side "V92S" : V.92, server side "K56" : K56flex <automode1>: 0 or 1 (automatic modulation negotiation) <min_tx_rate1>, <max_tx_rate1>,<min_rx_rate1>,<max_rx_rate1>: Minimum and maximum data rates B103: 300 B212: TX75/RX1200 or TX1220/RX75 V21: 300 V22: 1200 V22B: 1200, 2400 V23C: 1200 V32: 4800, 9600 V32B: 4800, 7200, 9600, 12000, V34: 2400, 4800, 7200, 9600, 12000, 14400, 16800, 19200, 21600, 24000, 28800, 31200, V90: (server): 28000, 29333, 30667, 32000, 33333, 34667, 36000, 37333, 38667, 40000, 41333, 42667, 44000, 45333, 46667, 48000, 49333, 50667, 52000, 53333, 54667, V92: (server): 28000, 29333, 30667, 32000, 33333, 34667, 36000, 37333, 38667, 40000, 41333, 42667, 45333, 46667, 48000, 49333, 50667, 52000, 53333, 54667, V92: (client): 24000, 25333, 26667, 28000, 29333, 30667, 32000, 33333, 34667, 36000, 37333, 38667, 40000, 41333,

19 42667, 44000, 45333, 46667, K56: 32000, 34000, 36000, 38000, 40000, 42000, 44000, 46000, 48000, 50000, 52000, 54000, "AT+MS=" old syntax: (all fields are optional) AT+MS=<mod2>, <automode2>, <min_rate2>, <max_rate2>, <x_law2>, <rb_signaling2> <mod2>: string, one of 0 : V.21 1 : V.22 2 : V.22bis 3 : V.23 9 : V : V.32bis 11 : V : V : V.92 (Netbricks extension) 56 : K56flex 64 : Bell : Bell : V.22 Fast Connect <automode2>: 0 or 1 (automatic modulation negotiation) <min_rate2>, <max_rate2> : minimum and maximum data rates Bell 103: 300 Bell 212: 1200 V.21 : 300 V.22 : 1200 V.22bis : 1200, 2400 V.23 : 1200 V.32 : 4800, 9600 V.32bis : 4800, 7200, 9600, 12000, V.34 : 2400, 4800, 7200, 9600, 12000, 14400, 16800, 19200, 21600, 24000, 28800, 31200, 33600

20 V.90: (server): 28000, 29333, 30667, 32000, 33333, 34667, 36000, 37333, 38667, 40000, 41333, 42667, 44000, 45333, 46667, 48000, 49333, 50667, 52000, 53333, 54667, V.92: (server): 28000, 29333, 30667, 32000, 33333, 34667, 36000, 37333, 38667, 40000, 41333, 42667, 45333, 46667, 48000, 49333, 50667, 52000, 53333, 54667, V.92: (client): 24000, 25333, 26667, 28000, 29333, 30667, 32000, 33333, 34667, 36000, 37333, 38667, 40000, 41333, 42667, 44000, 45333, 46667, K56flex: 32000, 34000, 36000, 38000, 40000, 42000, 44000, 46000, 48000, 50000, 52000, 54000, Extended "ATF" (Select Line Modulation) syntax: F0 : select auto-detect mode F1 : V.21 or Bell 103 (according to B setting) (ATN0S37=1) F2 : F3 : V.23 (org: TX75, ans: TX1200) (ATN0S37=7) F4 : V (ATN0S37=5) F5 : V.22bis 2400 (Implies ATN0S37=6) F6 : V.32bis 4800 or V (ATN0S37=8) F7 : V.32bis 7200 (ATN0S37=12) F8 : V.32bis 9600 or V (ATN0S37=9)

21 F9 : V.32bis (ATN0S37=10) F10 : V.32bis (ATN0S37=11) F11 : V [Netbricks extension] (Implies ATN0S37=6) F12 : V [Netbricks extension] (Implies ATN0S37=7) F13 : V [Netbricks extension] (Implies ATN0S37=8) F14 : V [Netbricks extension] (Implies ATN0S37=9) F15 : V [Netbricks extension] (Implies ATN0S37=10) F16 : V [Netbricks extension] (Implies ATN0S37=11) F17 : V [Netbricks extension] (Implies ATN0S37=26) F18 : V [Netbricks extension] (Implies ATN0S37=27) F19 : V [Netbricks extension] (Implies ATN0S37=33) F20 : V [Netbricks extension] (Implies ATN0S37=29) F21 : V [Netbricks extension] (Implies ATN0S37=34) F22 : V [Netbricks extension] (Implies ATN0S37=15) F23 : V [Netbricks extension] (Implies ATN0S37=36) F24 : V [Netbricks extension] (Implies ATN0S37=12) $M commands Old AT$M commands are supported for modem

22 AT$M248: Bell / CCITT answer tone detection (no action on modem >0 2.20) AT$M249: Short SB1 China / Taiwan idem ATS145=1 in version < AT$M250: Disable V.22 Fast connect (switch in V.22) and BELL mode AT$M251: Skip 2100 / USB DETAILED DESCRIPTION OF MAIN MODEM REGISTERS The modem uses registers to store the configuration and operation parameters. The configuration registers have default value. The S registers can be given a value which is not comprised in the specified range. However, this can lead to modem malfunctions. The contents of each register can be read and written by the application. Site-tests are recommended to fine-adjust the operational choices to improve the modem s permittance. Modifications with respect to the nominal configuration can be performed exceptionally and approved by a telecom specialist REGISTER S0 Function: Defines number of rings before answering. This register is only significant when the modem is configured for calling/called mode. It defines the number of rings after which the modem must automatically answer a call. Range of values: 0 to 255 Value 0 disables the automatic reply mode. In this case, line seizure is ensured by the application (ATA command). Default value: 0 or 1

23 Note: The default mode for modem operation in the calling mode REGISTER S6 Function: Pause before blind dialling This register defines the waiting time before dialling a number in blind. Range of values: 0 up to 255 in multiples of seconds. Default value: REGISTER S7 Function: Connection completion time out This register defines the maximum delay for successful call establishment. Range of values: 0 up to 255 in seconds. Default value: 60, i.e. 60 seconds. In most applications, the time out value is greater or equal 60s REGISTER S8 Function: comma dial modifier This register contains the time duration for the comma option during a dialling process Range of values: 0 up to 255 in seconds. Default value: 2, i.e. 2 seconds.

24 REGISTER S10 Function: Carrier loss response time Duration when carrier signal must be absent to disconnect Range of values: 0 up to 255 in tenths of seconds Default value: 20, i.e. 2 seconds REGISTER S11 Function: Inter digit pause time in DTMF dialling mode. This register defines the waiting time between each set of digits dialled and sent to the automatic exchange (equivalent to inter-digit pause). Range of values: 50 up to 255 in tenth of seconds. Default value: 50, i.e. 500 ms. The two most currently used values are: 900 +/- 100 ms 450 +/- 50 ms REGISTER S14 Function: Delay to wait for dial tone. This register defines the time to wait for a dial tone in seconds. Range of values: 0 up to 255 Default value: 0

25 REGISTER S37 Function: Line modulation selection Range of values: 0: automode connection: highest possible speed 1..3: V bps 4: 600 bps 5: V bps 6: V22bis 2400 bps 7: V bps 8: 7200 bps 9: V bps 10: V32bis bps 11: V32bis bps Default value: 0 i.e multi mode REGISTER S144 Function: Synchronous modem D7 D6 D5 D4 D3 D2 D1 D FRM I CRC R Bit 0 : reverse bit polarity (for Async, HDLC and transparent mode) 0: default (do not reverse bit polarity), 1: reverse bit polarity. Bits 1-2 : CRC type (for HDLC framing mode only) 0: default (standard CRC-16, initialized to 0xFFFF) 2: CRC-16, initialized to 0

26 Values 4 and 6 are reserved Bit 3 : Processing of Rx frame CRC 0: default (check CRC and reject bad frame) 8: ignore CRC Bits 4-5 : framing mode 0 : default (asynchronous framing) 16: HDLC framing 32: transparent value 48 is reserved Rem: This register is ignored if a data protocol is enabled: V.42, MNP4,... Range of values: 0: Asynchronous 1 : Asynchronous + Reversal Polarity 16 : HDLC 17 : HDLC+ Reversal Polarity 19 : HDLC+ Reversal Polarity + Init CRC 0 25 : HDLC+ Reversal Polarity + Ignore CRC Default value: 0 asynchronous REGISTER S145 Function: Short SB1 for Fast CONNECT 1: Short SB1 Default value: 99 normal 4.36 Synchronous modem See the specific documentation on Synchronous modem

27 5. maintenance routines 5.1 DIAGNOSTICs The OS handles a diagnostic area and access interfaces for applications. This area is divided into three parts: Counters area, Faults area, Free text area. The fault recordings, texts and counter incrementation are achieved using upload_diagnostic_xxx routines 3 interface routines are available at application level: upload_diagnostic_cpt upload_diagnostic_txt upload_diagnostic_def 6. COMMANDS summary 6.1 SUMMARY OF MODEM COMMANDS Comma nd Default Configuratio n Description A Take the line on incoming call D Dial a number

28 En E0 Enable/disable echo Fn F0 Set up the line modulation Hn H0 Request line hang-up or seizure In Supply modem information Nn N0 Single mode/ Multi-mode operation O Transfer from command mode to data mode Sr = n Assign <n> value to register <r> Sr? Supply value recorded in register <r> Vn V1 Supply result codes in numerical form or as string Wn W0 Select negotiation progress information Xn X4 Call progress monitoring Z Reinitialise modem and use the current profile &Qn &Q0 Select communication mode (Async or sync) &V Supply all active configuration parameters recorded in registers \Nn \N3 Select Error correction level %Cn %C0 Select Data compression

29 6.2 SUMMARY OF MODEM REGISTERS Register Default Range or Description Value Resolution S0 0 0 to 3 Selects number of rings before answering S6 0 0 to 255 Pause before blind dialling S to 255 Connection completion TimeOut S8 2 0 to 255 Comma dial duration time S to 255 Carrier loss response time S to 255 DTMF inter digit pause duration? S to 255 Delay to wait for dial tone S to 255 Line modulation selection