The report generator in the Blueye App uses Word (.docx) files as templates to define which fields to include, and how the report should look like. The app includes a default template, but it is also possible for advanced users to define their own template. We recommend downloading the two example reports attached to this article, and use these as examples or starting points for your own report template:
- DefaultReportTemplate.docx - The default template used by the app
- ReferenceReportTemplate.docx - A reference template which includes all available fields, used by the Blueye development team for testing
Working with Merge Fields
Mail merge is a feature of Microsoft Word traditionally used to create templates, such as a letter going out to a group of people, where you do not want to manually change the name and address for each recipient. We use the same functionality to generate and export dive reports from the Blueye App.
Inserting a Merge Field in Word for macOS
The ReferenceReportTemplate.docx file. Merge fields are denoted with a «FieldName», and they are highlighted when you click the field.
You can insert a new Merge Field by clicking the Insert menu, and then selecting Field... element. This will bring up this dialog, where you must select the Mail Merge category and the MergeField field name. Type in your field name as MERGEFIELD Title (or whatever field you which to use). See Available merge fields for a complete list of available fields.
The dialog used to insert a Merge Field in Word on macOS. Remember to not remove the MERGEFIELD prefix when inserting a new field.
Selecting a custom template
You select which template you wish to use under Settings - App settings. Select the Custom option under the Dive Report Template section, and tap the Select button to select your custom report template file. You can tap the file name to preview the selected template.
Transferring templates from your computer to your device
We recommend creating the report template on a computer and then transferring the file to your device for testing. Both iOS and Android have different mechanisms for transferring files from a computer to your device, which include:
- AirDrop or iCloud (iOS)
- Using your Google Account or USB cable (Android)
- File synchronization apps such as DropBox, Google Drive, One Drive
- E-mailing the file to yourself
We cannot include detailed instructions for all scenarios but don't hesitate to contact support@blueye.no for further assistance.
Available merge fields
The following tables list all available merge fields you can include in a custom report template. Some are normal merge fields where a simple value will be inserted, while others are groups (lists) of items, or special tables or charts.
Normal merge fields
| Name | Description | Example |
|---|---|---|
AppVersion |
Version information about the Blueye app that created the report | 1.13.0 |
DroneSerialNumber |
The serial number of the drone | BYEDP1900000 |
DroneSoftwareVersion |
Version information about the Blueye drone that conducted the dive | 1.5.37-rockomaster |
FileName |
The file name assigned to the report file | 2020-03-17-122 - Blueye Dive Report.pdf |
ReportDate |
The date the report file was generated | Monday 4th of May 2020 |
Title |
User assigned title for the dive | Pipe Inspection |
Description |
User assigned description for the dive | Inspection of wastewater pipes. |
OperatorName |
User assigned name of the drone operator | John Doe |
OperatorEmail |
User assigned e-mail of the drone operator | john@doe.com |
OperatorPhoneNumber |
User assigned phone number of the drone operator | +47 40004643 |
DiveLocationLat |
Latitude GPS coordinate of the drone operator | 63.449 |
DiveLocationLon |
Longitude GPS coordinate of the drone operator | 10.427 |
DiveAddress |
Reverse geolocated address of the drone operator GPS location | Trondheim, Norway |
Image:Map |
A map showing the drone operator GPS location | |
DiveDate |
Date of the dive | Tuesday 17th of March 2020 |
DiveStartTime |
Time of day when the dive started | 12:22 |
DiveStartTimeUtc |
Time of day, in UTC, when the dive started | 14:22 |
DiveStartDateTime |
Full date and time for when the dive started | 17.03.2020 12:22 |
DiveStartDateTimeUtc |
Full date and time, in UTC, for when the dive started | 17.03.2020 14:22 |
DiveEndTime |
Time of day when the dive ended | 13:30 |
DiveEndTimeUtc |
time of day, in UTC, when the dive ended | 15:30 |
DiveEndDateTime |
Full date and time for when the dive ended | 17.03.2020 13:30 |
DiveEndDateTimeUtc |
Full date and time, in UTC, for when the dive ended | 17.03.2020 15:30 |
DiveDuration |
Duration of the dive | 00:54:30 |
DepthMax |
The maximum depth of dive | 26.0 m |
DepthAvg |
The average depth of dive | 8.6 m |
DepthHours |
Depth hours of the dive | 7.9 m/h |
TempWaterMax |
The maximum water temperature | 17.4 °C |
TempWaterMin |
The minimum water temperature | 4.3 °C |
TempWaterAvg |
The average water temperature | 10.4 °C |
BatteryCurrentMax |
The maximum power usage in Amp | 5.8 A |
BatteryCurrentMin |
The minimum power usage in Amp | 0.4 A |
BatteryCurrentAvg |
The average power usage in Amp | 1.7 A |
BatterySOCMax |
The maximum battery state of charge | 92.0% |
BatterySOCMin |
The minimum battery state of charge | 65.0% |
BatterySOCRate |
The battery usage rate in percentage/hour | 29.5%/h |
Merge Groups
Merge Groups are special merge fields used for lists of elements, such as a list of pictures or video files. They start with a BeginGroup field and end with an EndGroup field. In between the group fields, you insert your merge field, such as VideoFileName.
| Name | Description | Example |
|---|---|---|
BeginGroup:Pictures |
Begin a merge group for pictures | |
PictureFileName |
For each picture in the group, insert the picture filename | picture_BYEDP00000_2020-03-17-123341.jpg |
Image:PictureFileName |
For each picture in the group, insert the actual picture into the report. | |
EndGroup:Pictures |
End the merge group for pictures | |
BeginGroup:Videos |
Begin a merge group for videos | |
VideoFileName |
For each video in the group, insert the video filename | video_BYEDP00000_2020-03-17-123341.mp4 |
Merge Tables
Merge Tables are special tables that will be populated when generating the report. Create an empty table, and insert the Merge Field in the first column, to indicate that this table should be populated.
| Name | Description |
|---|---|
Table:Pictures |
A table of pictures, where the initial table indicates the number of columns in the table. The pictures will be inserted into the table. |
Example showing how the Table:Pictures merge field can be used to generate a table of pictures.
Merge Charts
Merge Charts are special charts that will be updated with data from the dive log. For now, you have to copy these charts across from the ReferenceReportTemplate.docx file.
| Name | Description |
|---|---|
Depth |
A chart showing the depth profile of the dive |
Comments
0 comments