Octans
Octans
Advanced Configuration
User Guide
AHRS - Advanced Configuration - User Guide
Copyright
All rights reserved. No part of this manual may be reproduced or transmitted, in any form
or by any means, whether electronic, printed manual or otherwise, including but not
limited to photocopying, recording or information storage and retrieval systems, for any
purpose without prior written permission of iXBlue.
Disclaimer
iXBlue specifically disclaims all warranties, either expressed or implied, included but not
limited to implied warranties of merchantability and fitness for a particular purpose with
respect to this product and documentation. iXBlue reserves the right to revise or make
changes or improvments to this product or documentation at any time without notify any
person of such revision or improvments.
In no event shall iXBlue be liable for any consequential or incidental damages, including
but not limited to loss of business profits or any commercial damages, arising out of the
use of this product.
Trademarks
Microsoft, MS-DOS and Windows are registered trademarks of Microsoft Corporation.
Intel and Pentium are registered trademarks and Celeron is a trademark of Intel
Corporation.
Text Usage
bold Bold text is used for items you must select or click in the
software. It is also used for the field names used into the dialog
box.
Courier Text in this font denotes text or characters that you should enter
from the keyboard, the proper names of disk Drives, paths,
directories, programs, functions, filenames and extensions.
italic Italic text is the result of an action in the procedures.
Icons
The Note icon indicates that the following information is of particular interest and should
be read with care.
Important
The Important mention indicates that the following information should be read to forbid or
prevent a product dysfunction or a faulty operation of the equipment.
The Caution icon indicates that the following information should be read to forbid or
prevent product damage.
The Warning icon indicates that possible personal injury or death could result from failure
to follow the provided recommendation.
This document is the Advanced Configuration User Guide for the Attitude and Heading
Reference Sensor (AHRS). This document is a part of the set of documentation provided
with the AHRS. The set of documentation must be read and understood prior to using the
AHRS.
The manufacturer shall in no case be held liable for any application or use that does not
comply with the stipulations in this guide.
AHRS – Advanced Configuration - User Guide is divided into several parts:
• Part 1: Introduction – This part introduces the commands describes in this user
guide.
• Part 2: Version of Products Concerned – This part lists all the products and the
firmware version associated to which this user guide applies. This section lists the
availability of the commands depending on the products.
• Part 3: General Conventions – This part describes command syntax and how to send
and receive commands.
• Part 4: General System Configuration – This part lists the available commands to
configure the AHRS.
• Part 5: Interfaces Configuration – This part describes commands to configure serial
or Ethernet ports and analog Inputs and Outputs (I/O).
• Part 6: Dynamic String Retrieve Commands: This part describes commands to
retrieve all configuration strings to dynamically get firmware feature list.
• Appendix A: NMEA Checksum Web Page – This appendix gives a mean to calculate
the checksum (“hh” parameter) required in all transmitted sentences.
• Appendix B: Factory Setting Details – This appendix details the factory default
settings.
Table of Contents
1 INTRODUCTION .............................................................................................................. 6
2 VERSION AND PRODUCTS CONCERNED .......................................................................... 7
3 GENERAL CONVENTIONS ............................................................................................... 8
3.1 COMMAND SYNTAX ..................................................................................................................... 8
3.2 HOW TO SEND AND RECEIVE COMMANDS..................................................................................... 8
APPENDICES..................................................................................................................... 26
A NMEA CHECKSUM WEB PAGE .................................................................................... 26
B ORIENTATION AND SIGN CONVENTIONS RECALL ............................................................ 27
C FACTORY SETTING DETAILS......................................................................................... 28
1 INTRODUCTION
This document describes the Attitude and Heading Reference Sensor (AHRS)
configuration and monitoring commands which can be used during operation. These
commands are sent directly through the repeater port to check settings and modify AHRS
or external sensors configuration (depending of the external sensor and of the AHRS
capabilities), to reset the unit, and save the configuration to PROM.
Full configuration of the AHRS, prior to operation, requires the use of the Web-based User
Interface.
However, commands described below are exactly equivalent to the ones which are sent
by the Web-based User Interface. They may be useful when launching and using the
Web-based User Interface during operation is not possible.
th
The current edition of this document is applicable to the following 4 generation AHRS:
Refer to section 6.1 to check the firmware version currently downloaded into your unit.
Several commands described in this manual are associated with specific external
sensors that may not be available on your product. Please, refer to your Product User
Manual to check which external sensors are available.
Contact iXBlue customer support to get the updated firmware version to be downloaded
into your system (see document: Inertial Products - General Information (Ref.: MU-
INS&AHRS-AN-007) for contact information).
3 GENERAL CONVENTIONS
Message $PHSAV,,*5C<CR><LF>
Title Save Configuration to EEPROM
Message $PHST_,RESET,,*39<CR><LF>
Title Restart AHRS algorithm
Warning
Unit will restart with the configuration saved into PROM. It is recommended to perform a
save to PROM command (see section 4.1) before resetting if you changed the settings
and want to keep them.
Message $PIXSE,CONFIG,PWDRST*4B<CR><LF>
Title Reset Web-based User Interface Passwords
Message $PHMAN,x.x,y.y*hh<CR><LF>
Title Manual Position
Data Field Semantics Unit Type
x.x Latitude, positive north Degree Float
y.y Speed knots Float
To retrieve current manual position and speed:
$PHMAN,,*5A<CR><LF>
Message $PHORI,i*hh<CR><LF>
Title Axis Orientation
Data Field Semantics Syntax Type
i Index of the rough misalignment See int
Table 2 for index/orientation
correspondence and checksums
To retrieve the axis orientation – also called the rough misalignment –:
$PHORI,,*4C<CR><LF>
Important
Table 2 - Matching between index i and AHRS axis orientation with associated checksum (hh)
i (hh) Orientation (Surface) Orientation (Subsea) i (hh) Orientation (Surface) Orientation (Subsea)
0 1
(50) (51)
2 3
(52) (53)
4 5
(54) (55)
i (hh) Orientation (Surface) Orientation (Subsea) i (hh) Orientation (Surface) Orientation (Subsea)
6 7
(56) (57)
8 9
(58) (59)
10 11
(61) (60)
12 13
(63) (62)
14 15
(65) (64)
16 17
(67) (66)
i (hh) Orientation (Surface) Orientation (Subsea) i (hh) Orientation (Surface) Orientation (Subsea)
18 19
(69) (68)
20 21
(62) (63)
22 23
(60) (61)
Message $PHBIA,x.x,y.y,z.z*hh<CR><LF>
Title Angular offsets Configuration
Data Field Semantics Unit Type
x.x Vehicle X1 rotation offset Degree Float
y.y Vehicle X2 rotation offset Degree Float
z.z Vehicle X3 rotation offset Degree Float
To retrieve the angular offsets:
$PHBIA,,*52<CR><LF>
Message $PHLEV,x.x,y.y,z.z*hh<CR><LF>
Title Lever Arms Configuration
Data Field Semantics Unit Type
x.x XV1 lever arm m Float
y.y XV2 lever arm m Float
z.z XV3 lever arm m Float
To retrieve main monitoring point lever arms from the AHRS:
$PHLEV,,*47<CR><LF>
Message $PHLVx,x.x,y.y,z.z*hh<CR><LF>
Title Lever Arms Configuration
Data Field Semantics Unit Type
x Lever arm (‘A’, ‘B’ or ‘C’) N/A Char
x.x XV1 lever arm m Float
y.y XV2 lever arm m Float
z.z XV3 lever arm m Float
To retrieve secondary monitoring point lever arms from the AHRS:
$PHLVA,,*43<CR><LF>
$PHLVB,,*40<CR><LF>
$PHLVC,,*41<CR><LF>
Message $PHCNF,COG___,x.x,y.y,z.z*hh<CR><LF>
Title Lever Arms Configuration
Data Field Semantics Unit Type
x.x XV1 cog m Float
y.y XV2 cog m Float
z.z XV3 cog m Float
(please note the 3 underscore(’’_’’) characters after COG header)
To retrieve center of gravity from the AHRS:
$PHCNF,COG___,,*6B<CR><LF>
Message $PHCNF,HVECNF_,i*hh<CR><LF>
Title Heave Parameters
Data Field Semantics Syntax Type
0: Slight Sea (<1.2m)
1: Moderate Sea (<2.5m)
i Index int
2: Rough Sea (>2.5m)
3: Harbors and Channels
To retrieve the current sea state mode:
$PHCNF,HVECNF,,*30<CR><LF>
Message $PHCNF,UTCINT,i,j*hh<CR><LF>
Title UTC Interface
Data Field Semantics Syntax Type
0: None
1: Port A
i Interface 2: Port B int
…
5 : Port E
j (Deprecated) 0 int
5 INTERFACES CONFIGURATION
5.2.1 SERIAL I/O GENERAL PARAMETERS (PARITY, STOP BIT, LEVEL, BAUDRATE)
Used to configure the parity and stop bit for serial port X :
Message $PHCNF,RSCM_X,i,j,k,l*hh<CR><LF>
To retrieve parity and stop bit for serial port X (checksum hh depends on port X, see
below) :
$PHCNF,RSCM_A,,*6E<CR><LF>
$PHCNF,RSCM_B,,*6D<CR><LF>
$PHCNF,RSCM_C,,*6C<CR><LF>
$PHCNF,RSCM_D,,*6B<CR><LF>
$PHCNF,RSCM_E,,*6A<CR><LF>
Message $PHCNF,RSIN_x,i,j*hh<CR><LF>
Title Input port configuration
Data Field Semantics Syntax Type
(Uppercase)
OCTANS : set D to G to configure ports A to D.
x Port For more explanation, refer to § 5.1. char
OCTANS 3000 : set A to E to configure Port A to Port E
OCTANS NANO: set A to D to configure Port A to Port D
i protocol See Table 3 int
j RFU Set this field to 0 int
The RSIN command must be used to select input protocol in Ethernet mode too.
OCTANS CINT firmware =< 4.00 OCTANS CINT Firmware > 4.00 OCTANS NANO
Index Protocol Index Protocol Index Protocol
0 NONE 0 NONE 0 NONE
1 DCN_LOCH 1 DCN_LOCH 1 STANDARD NMEA
2 DCN_NAV1 2 DCN_NAV1
3 GPS_GGA 3 STANDARD NMEA
4 GPS_VTG
5 GPS_GGA-VTG-ZDA
6 GPS_GLL-VHW
7 GPS_ZDA
8 AMS
9 ISRGVT
10 GPS_GGA-VTG-UTC
11 ALERT_IN
Message $PHCN,RSUDPx,ssss*hh<CR><LF>
Title Output port configuration
Data Field Semantics Syntax Type
(Uppercase)
OCTANS: set A to C to configure Port A to Port C
x Port char
OCTANS 3000: set A to E to configure Port A to Port E
OCTANS NANO: set A to E to configure Port A to Port E
ssss protocol User defined protocol string string
Message $PHCNF,RSOUTx,i,j,k,l,m*hh<CR><LF>
Title Output port configuration
Data Field Semantics Syntax Type
(Uppercase)
OCTANS: set A to C to configure Port A to Port C
x Port char
OCTANS 3000: set A to E to configure Port A to Port E
OCTANS NANO: set A to E to configure Port A to Port E
See $PHCNF,RSOUTA,,*71<CR><LF>
$PHCNF,RSOUTB,,*72<CR><LF>
$PHCNF,RSOUTC,,*73<CR><LF>
i Protocol $PHCNF,RSOUTD,,*74<CR><LF> int
$PHCNF,RSOUTE,,*75<CR><LF>
Table 4
0: Main lever arm
1: Secondary lever arm 1
j Lever arm int
2: Secondary lever arm 2
3: Secondary lever arm 3
Output rate in ms (100 = 100ms = 10 Hz)
k Rate int
Minimum value is 5 ms (200 Hz)
0: Real Time Heave
l Heave 1: Smart Heave (100s delayed) int
For OCTANS NANO set to 0
0: ZDA not outputted
m ZDA output int
1: ZDA outputted
$PHCNF,RSOUTA,,*71<CR><LF>
$PHCNF,RSOUTB,,*72<CR><LF>
$PHCNF,RSOUTC,,*73<CR><LF>
$PHCNF,RSOUTD,,*74<CR><LF>
$PHCNF,RSOUTE,,*75<CR><LF>
Table 4 - list and index of output protocols
To select the device that will be used for data output on selected port:
Message $PHCNF,EDIROx,i*hh<CR><LF>
Title Output device selection
Data Field Semantics Syntax Type
(Uppercase)
OCTANS: set A to C to configure Port A to Port C
x Port char
OCTANS 3000: set A to E to configure Port A to Port E
OCTANS NANO: set A to E to configure Port A to Port E
0: No device selected
1: Serial output on selected port
i Device int
2: Ethernet output on selected port
3: Ethernet and serial output on selected port
To retrieve network configuration:
$PHCNF,EDIROA,,*6B<CR><LF>
$PHCNF,EDIROB,,*68<CR><LF>
$PHCNF,EDIROC,,*69<CR><LF>
$PHCNF,EDIROB,,*6E<CR><LF>
$PHCNF,EDIROC,,*6F<CR><LF>
To select the device that will be used for data input on selected port:
Message $PHCNF,EDIRIx,i*hh<CR><LF>
Title Input device selection
Data Field Semantics Syntax Type
(Uppercase)
OCTANS: set D to G to configure Port A to Port D
x Port For more explanation, refer to § 5.1. char
OCTANS 3000: set A to E to configure Port A to Port E
OCTANS NANO: set A to D to configure Port A to Port D
0: No device selected
i Device 1: Serial input on selected port int
2: Ethernet input on selected port
To retrieve network configuration on port:
$PHCNF,EDIRIA,,*6D<CR><LF>
$PHCNF,EDIRIB,,*6E<CR><LF>
$PHCNF,EDIRIC,,*6F<CR><LF>
$PHCNF,EDIRID,,*68<CR><LF>
$PHCNF,EDIRIE,,*69<CR><LF>
Use this command to configure Ethernet network settings. These settings will be effective
after next reboot only.
Message $PHCNF,ETHIP,D,I,N[,G][,H]*hh<CR><LF>
Title Ethernet configuration
Data Field Semantics Syntax Type
D DHCP 0: disable DHCP at boot time, 1: enable DHCP Int
I IP address System IP address (ex: 192.168.36.100) IP address
N Netmask Network mask (ex: 255.255.255.0) IP address
G Gateway Gateway (ex: 192.168.36.254) IP address
H DNS DNS (ex: 192.168.36.1) IP address
P GPS IP Embedded GPS IP address IP address
Message $PHCNF,ELCFOx,m,i,p*hh<CR><LF>
Title IP output settings
Data Field Semantics Syntax Type
(Uppercase)
OCTANS: set A to C to configure Port A to Port C
x Port char
OCTANS 3000: set A to E to configure Port A to Port E
OCTANS NANO: set A to E to configure Port A to Port E
IP output mode:
0: TCP server
1: TCP client
m Mode int
2: UDP point to point
3: UDP broadcast
4: UDP multicast
IP address to connect to. This field is ignored in TCP
i Destination IP IP address
server and UDP broadcast modes.
p IP Port Port to connect/listen to int
To retrieve IP output settings on port x, use the following command:
$PHCNF,ELCFOA,,*7D<CR><LF>
$PHCNF,ELCFOB,,*7E<CR><LF>
$PHCNF,ELCFOC,,*7F<CR><LF>
$PHCNF,ELCFOD,,*78<CR><LF>
$PHCNF,ELCFOE,,*79<CR><LF>
Message $PHCNF,ELCFIx,m,i,p*hh<CR><LF>
Title IP input settings
Data Field Semantics Syntax Type
(Uppercase)
OCTANS:
set D to configure the Port A
x Port set E to configure the Port B. char
For more explanation, refer to § 5.1.
OCTANS 3000: set A to E to configure Port A to Port E
OCTANS NANO: set A to D to configure Port A to Port D
IP input mode:
0: TCP server
1: TCP client
m Mode int
2: UDP point to point
3: UDP broadcast
4: UDP multicast
Destination IP address to connect to. This field is ignored in TCP server and IP
i
IP UDP broadcast modes. address
p IP Port Port to connect/listen to int
Message $PHCNF,PULSINx,i,x.x*hh<CR><LF>
Title Pulse Input
Data Field Semantics Syntax Type
(Uppercase)
OCTANS: set A to D to configure Port A to Port D
x Port char
OCTANS 3000: set A to C to configure Port A to Port C
OCTANS NANO: set A to configure Port A
0: None
1: PPS Rising + Time
2: PPS Falling + Time
3: Time + PPS Rising
4: Time + PPS Falling
5: Output A Synchro
i Protocol 6: Output B Synchro int
7: Output C Synchro
8: Output D Synchro
9: Output E Synchro
10 to 13: Reserved
14: Log
15: Odo
x.x RFU Set this field to 0.0 Float
Message $PHCNF,PULSOx,i,x.x*hh<CR><LF>
Title Output Pulses
Data Field Semantics Syntax Type
OCTANS/OCTANS 3000: set A or B to configure Port A or Port B
x Port char
OCTANS NANO: None
0 : None
1: SerOutput A RTC
i Protocol int
2: SerOutput B RTC
3 SerOutput C RTC
x.x RFU Set this field to 0.0 Float
Note: the protocol parameter is only used on factory protocols for now (heading, roll, pitch
trigger). When not used, this parameter can be set to 0.0.
To retrieve configuration of pulse output X:
$PHCNF,PULSOA,,*6B<CR><LF>
$PHCNF,PULSOB,,*68<CR><LF>
This section describes commands to retrieve all configuration strings to dynamically get
firmware feature list.
Message $PHTXT,list,c,i,j*hh<CR><LF>
Title Text list retrieve
Data Field Semantics Syntax Type
list List name Name of command associated to the list string
c Language Only English ‘E’ is supported char
i Section index Index of list to retrieve for this command int
j String index Index of string in the list int
Example:
To retrieve first serial output protocol name, you should send:
$PHTXT,RSOUTX,E,1,0*13<CR><LF>
The AHRS will then answer:
$PHTXT,RSOUTX,1,0,NONE*5C<CR><LF>
When no string is available, the AHRS returns “________________” (16 x ‘_’ character).
Thus, to retrieve all available output protocol names, you should send
$PHTXT,RSOUTX command and increment string index until the firmware answers no
string available.
Following table details all string retrieve functions and their parameters:
Appendices
To get a simple NMEA computation tool, copy following code into a new file (nmea.html)
and save it, and open this file with your internet navigator:
--></script></head><body>
<h1>MTK NMEA checksum calculator</h1>
<p>This is a simple calculator to compute the checksum field of NMEA frames.</p>
<p> The checksum is simple, just an XOR of all the bytes between the
<tt>$</tt> and the <tt>*</tt> (not including the delimiters themselves), and written in
hexadecimal.</p>
<p>For this to work you'll need to be using a browser that supports JavaScript and DHTML
(most modern browsers do).</p>
<div style="margin:1em; padding: 2em; background: #ddddff;">
<form onsubmit="document.getElementById('commandfld').select(); return false;">
<table>
<tr><th align=right>Command:</th><td><tt>$<input id="commandfld" size=80 type="text"
onchange="updateChecksum(this.value);"
value="PIXSE,CONFIG,WAKEUP">*</tt></td></tr>
<tr><th align=right>With checksum:</th><td><span id="output" style="font-family:
monospace;"></span></td></tr>
</table></form></div>
<script>updateChecksum(document.getElementById("commandfld").value);</script>
<hr></body></html>
This page recaps orientation conventions for lever arms and misalignments.
Please refer to OCTANS user manuals for more details on frame transfer conventions.
Port
XV2
Stern Bow
XV3 XV1
Starboard
• XV1 lever arm is counted positive in direction of vehicle bow and negative in direction
of vehicle stern.
• XV2 lever arm is counted positive in direction of port side and negative in direction of
starboard side.
• XV3 lever arm is counter positive upward, negative downward.
Misalignments conventions:
XV2 +mP
X2
The above figures are an example to recap how can be estimated the sign of the angular
offsets.
Note: the roll misalignment is positive from X2 in direction to XV2, where pitch and
heading misalignments are positive from XV1 to X1.
• MPC settings:
All input and output port protocols are set to ‘NONE’, on primary lever arm
All output port protocols rate are set to 0Hz
Ethernet output ports are set from 8111 to 8115 for port A to E
Ethernet input ports are set from 8117 to 8121 for port A to E
Ethernet input and output target IP is set to 192.168.36.102 and mode is set to
”TCP server”
Serial settings for all ports are set to 9600 bps, none, 1 stop bit in RS232
UTC interface is set to ‘0’ (disabled)
All pulse in and out protocols are disabled (set to ‘0’)