Actions

Difference between revisions of "Character escape codes"

From Zenitel Wiki

 
(18 intermediate revisions by 3 users not shown)
Line 1: Line 1:
Escape sequences use an escape character to change the meaning of the characters which follow it. In the [[Event Handler]] backslash (\) or percent (%) is used as escape character. Escape sequences might be used in the [[EDO]] command to generate non-printable [http://en.wikipedia.org/wiki/ASCII ASCII] characters.
+
{{AI}}
 +
Escape sequences use an escape character to change the meaning of the characters which follow it. Escape sequences can be used for two purposes:
 +
* to use non-printable characters in [[Event_Handler#Built-In_Action_Commands|action strings]], e.g. in strings on [[EDO]] port and [[MPP]] commands
 +
* quoting: ignore special meaning of a character in eventhandler parser.
  
Some frequently used escape sequences:
+
The escape sequences are substituted when the eventhandler reads the action string. In the case of Data Protocol Commands ( @ $ ), the escape sequences are substituted ''before'' the messages are sent to the Data Protocol Router / Handler.
  \r = Carriage Return
 
\n = Line Feed
 
\t = Tab
 
\xhh : hh is any ASCII value in HEX
 
  
 +
In the AlphaCom the character backslash (\) is used as escape character.
  
 +
 +
Escape sequences:
 
{| border="1"
 
{| border="1"
! style="background:#ffdead;" width="30" | Char
+
! style="background:#ffdead;" width="70" | Escape sequence
! style="background:#ffdead;" width="70" | Code
+
! style="background:#ffdead;" width="70" | Result
! style="background:#ffdead;" width="70" | Alt. code
+
! style="background:#ffdead;" width="30" | Hex code
! style="background:#ffdead;" width="30" | Hex
+
! style="background:#ffdead;" width="550" | Description
! style="background:#ffdead;" width="150" | Description
 
 
|-
 
|-
| align=center| , || align=center|%, || align=center|%c || 2C || Comma
+
| align=center|\, || align=center| , || 2C || Comma
 
|-
 
|-
| align=center| ( || align=center|%( || align=center|%o || 28 || Opening parenthese
+
| align=center|\( || align=center| ( || 28 || Opening parenthese
 
|-
 
|-
| align=center| ) || align=center|%) || align=center|%p || 29 || Closing parenthese
+
| align=center|\) || align=center| ) || 29 || Closing parenthese
 
|-
 
|-
| align=center| " || align=center|%" || align=center|%d || 22 || Double quote
+
| align=center|\" || align=center| " || 22 || Double quote
 
|-
 
|-
| align=center| ; || align=center|%; || align=center|%e || 3B || Semicolon
+
| align=center|\; || align=center| ; || 3B || Semicolon
 
|-
 
|-
| align=center| \ || align=center|%\ ||   || 5C || Backslash
+
| align=center|\\ || align=center|\ || 5C || Backslash
 
|-
 
|-
| align=center| % || align=center|%% ||   || 25 || Percent
+
| align=center|\% || align=center|% || 25 || Percent
 
|-
 
|-
| align=center| TAB || align=center|%t ||   || 09 || ASCII TAB (Horisontal tab)
+
| align=center|\t || align=center|TAB || 09 || ASCII TAB (Horisontal tab)
 
|-
 
|-
| align=center| SP || align=center|%s ||   || 20 || Space
+
| align=center|\s || align=center|SP || 20 || Space
 
|-
 
|-
| align=center| CR || align=center|%r ||   || 0D || Carriage return
+
| align=center|\r || align=center|CR || 0D || Carriage return
 
|-
 
|-
| align=center| LF || align=center|%n ||   || 0A || Line feed
+
| align=center|\n || align=center|LF || 0A || Line feed
 
|-
 
|-
| align=center| BEL || align=center|%a ||   || 07 || Bell (Alert)
+
| align=center|\a || align=center|BEL || 07 || Bell (Alert)
 
|-
 
|-
| align=center| BS || align=center|%b ||   || 08 || Backspace
+
| align=center|\b || align=center|BS || 08 || Backspace
 
|-
 
|-
| align=center| NUL || align=center|%0 ||   || 00 || ASCII NUL
+
| align=center|\0 || align=center|NUL || 00 || ASCII NUL
 
|-
 
|-
| align=center|   || align=center|%xhh || align=center|%#hh ||   || 'hh' is the ASCII character code as 2 hex digits. Note that you must use 2 digits.
+
| align=center|\l ||   || 80 || Extended NUL ('\x80')
 
|-
 
|-
| align=center|   || align=center|%l ||   || 80 || Extended NUL ('\x80')
+
| align=center|\! || align=center|   ||   || Ignore rest of string
 
|-
 
|-
| align=center|   || align=center|%q ||   ||   || to quote next character in string (if not parameter or end of string)
+
| align=center|\xhh || align=center|   ||   || 'hh' is the ASCII character code as 2 hex digits. Note that you must use 2 digits.
 +
|-
 +
| align=center|\#hh || align=center|   ||   || 'hh' is the ASCII character code as 2 hex digits. Note that you must use 2 digits.
 
|-
 
|-
 
|}
 
|}
 
<br>
 
<br>
\ can be used instead of %.
 
  
 
<br>
 
<br>
By using the escape sequence '%xhh' all sorts of ASCII characters can be sent on the EDO port.
+
By using the escape sequence '\xhh' all sorts of ASCII characters can be generated.
 
<br><br>
 
<br><br>
Example: CR (Carriage Return), which has the hexadecimal value 0D, can be generated by any of the following escape sequences:
+
 
 
\r
 
%r
 
\x0D
 
%x0D
 
%#0D
 
  
 
[[Category:Event Handler]]
 
[[Category:Event Handler]]

Latest revision as of 15:13, 25 August 2020

AI.png

Escape sequences use an escape character to change the meaning of the characters which follow it. Escape sequences can be used for two purposes:

  • to use non-printable characters in action strings, e.g. in strings on EDO port and MPP commands
  • quoting: ignore special meaning of a character in eventhandler parser.

The escape sequences are substituted when the eventhandler reads the action string. In the case of Data Protocol Commands ( @ $ ), the escape sequences are substituted before the messages are sent to the Data Protocol Router / Handler.

In the AlphaCom the character backslash (\) is used as escape character.


Escape sequences:

Escape sequence Result Hex code Description
\, , 2C Comma
\( ( 28 Opening parenthese
\) ) 29 Closing parenthese
\" " 22 Double quote
\; ; 3B Semicolon
\\ \ 5C Backslash
\% % 25 Percent
\t TAB 09 ASCII TAB (Horisontal tab)
\s SP 20 Space
\r CR 0D Carriage return
\n LF 0A Line feed
\a BEL 07 Bell (Alert)
\b BS 08 Backspace
\0 NUL 00 ASCII NUL
\l   80 Extended NUL ('\x80')
\!     Ignore rest of string
\xhh     'hh' is the ASCII character code as 2 hex digits. Note that you must use 2 digits.
\#hh     'hh' is the ASCII character code as 2 hex digits. Note that you must use 2 digits.



By using the escape sequence '\xhh' all sorts of ASCII characters can be generated.