View source for Sending Codec12 commands using Hercules

==Description==
Hercules SETUP utility is useful serial port terminal (RS-485 or RS-232 terminal), UDP/IP terminal and TCP/IP Client Server terminal.It was created for HW group internal use only, but today it's includes many functions in one utility and it's Freeware! With our original devices (Serial/Ethernet Converter, RS-232/Ethernet Buffer or I/O Controller) it can be used for the UDP Config.

==Setting up for connection with Hercules Software==

{|style="width: 100%;"
|[[Image:GPRS_settings.png|right]]
<b>1.</b> Press <b>GPRS</b> tab<br>
* <b>''GPRS Context'' field requires you to enter your SIM providers' APN settings. Make sure to fill this in based on the SIM provider you are using with your Teltonika device.</b>
More information about ''GPRS'' panel and it's parameters for each device can be found here:

[[TST100 GPRS settings|TST100]] | [[TFT100 GPRS settings|TFT100]] | [[GH5200 GPRS settings|GH5200]] | [[TMT250 GPRS settings|TMT250]]
|}

{|style="width: 100%;"
|[[Image:Server_settings.png|right]]
<b>2.</b> In <b>GPRS</b>-><b>Server settings</b> -> <b>Domain</b> field, <b>External IP</b> of your <b>PC</b> must be entered.
There are several ways to find out your machine's external IP address:
* Visit the link provided to find out external IP address via website: [https://ping.eu/port-chk/ pingEU]<br>
* If you do not want to use a website you can find your IP through <b>Windows Command Prompt</b>.
* <b>Open Start</b> [[Image:WindowsSTART.png]] Click the Windows logo in the bottom-left corner of the screen, or press the <code>⊞ Win key</code>. You can search for Command Prompt on all supported versions of Windows.
* In the <b>Command Prompt</b> enter the following: <code>nslookup myip.opendns.com resolver1.opendns.com</code><br>
<b>Example window:</b> <br>

[[Image:External_IP_dnslookup.png|1000px|frame|center]]<br>
* Copy <b>Non-Authoritative answer Address</b><br>
* Paste <b>Non-Authoritative answer Address</b> in <i>Teltonika Configurator</i> <b>Server settings</b> -> <b>Domain</b> field<br>
* In <b>Port</b> field, enter an open port.
If it is unknown if the port is open, to check if the port is open click <code>[https://ping.eu/port-chk/ pingEU]</code> and enter <b>external IP address</b> and <b>port</b> and click <b>Go</b> button. <br>

[[Image:Ping.png|1000px|frame|center]]<br>

<b>Example window:</b>

[[Image:ServersettingsHercules.png|1000px|frame|center]]<br>
*Save settings to the device
|}

==Hercules Software==
<b>1.</b> Click <code>TCP Server</code><br>
<b>2.</b> Enter <b>Port</b> and click <code>Listen</code><br>
* When device connects to Hercules, device <i>IMEI</i> is sent and is displayed in <i>Received data</i> window
<b>4.</b> Tick <b>HEX</b> box<br>
<b>5.</b> Enter <b>Codec 12</b> command <code>000000000000000F0C010500000007676574696E666F0100004312</code> <i>getinfo (in example below)</i> <br>
<b>6.</b> Click <code>Send</code> button<br>
<b>Note</b>: To make device connect to Hercules faster, click any button, that has an event configured. In the example below, a button was pressed to send an SMS message. 

[[Image:Hercules_Codec12a.gif|1000px|frame|center]]<br>

==How to create a HEX command==
<b>getinfo</b> command <code>000000000000000F0C010500000007676574696E666F0100004312</code>

* Data size is calculated by the sum of bytes from <b>Codec ID</b> to <b>Command Quantity 2</b>. In this case it is 15 (<b>DEC</b>) or F (<b>HEX</b>)bytes.
* CRC-16 is calculated also by the sum of bytes from <b>Codec ID</b> to <b>Command Quantity 2</b>.
* To find out CRC-16 go to [https://www.scadacore.com/tools/programming-calculators/online-checksum-calculator/ CRC-16 calculator] page
* In HEX field enter the following <code>0C010500000007676574696E666F01</code> <b>getinfo</b> <i>All bytes in HEX from Codec ID to Command Quantity 2</i>
* Find <b>CRC-16-IBM</b> table
* <code>Reversed 0xA001</code> <b>Little Endian (DCBA)</b> shows <b>CRC-16</b>, which is <code>43 12</code><br>

<div style="text-align: center;"><b>CRC-16-IBM</b></div>
<div style="text-align: center;">(Bisync, Modbus, USB, ANSI X3.28, many others; also known as CRC-16 and CRC-16-ANSI)</div> 
{| class="wikitable" style="margin: 1em auto;"  

|-
| <b>Generator Type</b>
| <b> Big Endian (ABCD)</b>
| <b> Little Endian (DCBA)</b>
|-
| Normal 0x8005 || FE 8D || 8D FE
|-
| Reversed 0xA001 || 12 43 || <b>43 12</b>
|-
| Reversed Reciprocal 0xC002 || 64 22 || 22 64
|-
|}

Hexadecimal stream of GPRS command and answer in these examples are given in hexadecimal form. The different fields of messages are separate into different table columns for better readability and some of them are converted to ASCII values for better understanding. <br> <br>
<b>Example:</b> Sending ''[[Command: getinfo|getinfo]]'' SMS command via GPRS Codec12 <br> <br>
Server request in hexadecimal stream: <br>
<code>000000000000000F0C010500000007676574696E666F0100004312</code> <br> <br>
Parsed: 
{| class="nd-othertables_2" style="width:100%;"
|+
! colspan="2" style="border-bottom: 2px solid #0054A6; vertical-align: middle; text-align: center;" |Server Command
|-
! rowspan="1" style="width:14%; vertical-align: middle; text-align: center;" |Server Command Part
! rowspan="1" style="width:14%; vertical-align: middle; text-align: center;" |HEX Code Part
|-
| style="vertical-align: middle; text-align: center;" |Zero Bytes
| style="vertical-align: middle; text-align: center;" |00 00 00 00
|-
| style="vertical-align: middle; text-align: center;" |Data Size
| style="vertical-align: middle; text-align: center;" |00 00 00 0F
|-
| style="vertical-align: middle; text-align: center;" |Codec ID
| style="vertical-align: middle; text-align: center;" |0C
|-
| style="vertical-align: middle; text-align: center;" |Command Quantity 1
| style="vertical-align: middle; text-align: center;" |01
|-
| style="vertical-align: middle; text-align: center;" |Command Type
| style="vertical-align: middle; text-align: center;" |05
|-
| style="vertical-align: middle; text-align: center;" |Command Size
| style="vertical-align: middle; text-align: center;" |00 00 00 07
|-
| style="vertical-align: middle; text-align: center;" |Command
| style="vertical-align: middle; text-align: center;" |67 65 74 69 6E 66 6F
|-
| style="vertical-align: middle; text-align: center;" |Command Quantity 2
| style="vertical-align: middle; text-align: center;" |01
|-
| style="vertical-align: middle; text-align: center;" |CRC-16
| style="vertical-align: middle; text-align: center;" |00 00 43 12
|-
|} 
<b>Note</b>: that Server Command converted from HEX to ASCII means ''[[Command: getinfo|getinfo]]'' <br> <br>

<b>Example:</b>

When creating <code>getstatus</code> Codec 12 command:<br>
* '''Codec 12''' in HEX is <code>0C</code> <i>1 byte</i><br>
* '''Command Quantity 1''' is <code>01</code> <i>1 byte</i><br>
* '''Command Type''' is <code>05</code> <i>1 byte</i><br>
* '''Command Size''' is <code>00 00 00 09</code>, because <code>getstatus</code> converted in HEX is 9 bytes. <i>4 bytes</i><br>
* '''Command''' <code>getstatus</code> converted to HEX format is <code>67 65 74 73 74 61 74 75 73</code> <i>9 bytes</i><br>
* '''Command Quantity 2''' is <code>01</code> <i>1 byte</i><br>
* '''CRC-16''' converted from <code>0C01050000000967657473746174757301</code> is <code>00 00 8C D7</code> is <i>4 bytes</i><br>


{| class="nd-othertables_2" style="width:100%;"
|+
! colspan="2" style="border-bottom: 2px solid #0054A6; vertical-align: middle; text-align: center;" |Server Command
|-
! rowspan="1" style="width:14%; vertical-align: middle; text-align: center;" |Server Command Part
! rowspan="1" style="width:14%; vertical-align: middle; text-align: center;" |HEX Code Part
|-
| style="vertical-align: middle; text-align: center;" |Zero Bytes
| style="vertical-align: middle; text-align: center;" |00 00 00 00
|-
| style="vertical-align: middle; text-align: center;" |Data Size
| style="vertical-align: middle; text-align: center;" |00 00 00 11
|-
| style="vertical-align: middle; text-align: center;" |Codec ID
| style="vertical-align: middle; text-align: center;" |0C
|-
| style="vertical-align: middle; text-align: center;" |Command Quantity 1
| style="vertical-align: middle; text-align: center;" |01
|-
| style="vertical-align: middle; text-align: center;" |Command Type
| style="vertical-align: middle; text-align: center;" |05
|-
| style="vertical-align: middle; text-align: center;" |Command Size
| style="vertical-align: middle; text-align: center;" |00 00 00 09
|-
| style="vertical-align: middle; text-align: center;" |Command
| style="vertical-align: middle; text-align: center;" |67 65 74 73 74 61 74 75 73
|-
| style="vertical-align: middle; text-align: center;" |Command Quantity 2
| style="vertical-align: middle; text-align: center;" |01
|-
| style="vertical-align: middle; text-align: center;" |CRC-16
| style="vertical-align: middle; text-align: center;" |00 00 8C D7
|-
|}
[[Category: General Technical Questions]]