Merge pull request #520 from ArjanOnwezen/add-country-info-to-ais-app

Added country to AIS app, so you know from which country a vessel is.

firmware/application/apps/ais_app.cpp

@@ -22,6 +22,7 @@
 #include "ais_app.hpp"
 
 #include "string_format.hpp"
+#include "database.hpp"
 
 #include "baseband_api.hpp"
 
@@ -62,6 +63,25 @@ static std::string mmsi(
 	return to_string_dec_uint(mmsi, 9, '0'); // MMSI is always is always 9 characters pre-padded with zeros
 }
 
+
+static std::string mid(
+	const ais::MMSI& mmsi
+) {
+	std::database 			db;
+	std::string 			mid_code = "";
+	std::database::MidDBRecord 	mid_record = {};
+	int 				return_code = 0;
+
+	// Try getting the country name from mids.db using MID code for given MMSI
+	mid_code = to_string_dec_uint(mmsi, 9, ' ').substr(0, 3);
+	return_code = db.retrieve_mid_record(&mid_record, mid_code);
+	switch(return_code) {
+		case DATABASE_RECORD_FOUND: 	return mid_record.country;	
+		case DATABASE_NOT_FOUND: 	return "No mids.db file";
+		default:			return "";
+	}
+}
+
 static std::string navigational_status(const unsigned int value) {
 	switch(value) {
 		case 0: return "under way w/engine";
@@ -271,6 +291,7 @@ void AISRecentEntryDetailView::paint(Painter& painter) {
 	auto field_rect = Rect { rect.left(), rect.top() + 16, rect.width(), 16 };
 
 	field_rect = draw_field(painter, field_rect, s, "MMSI", ais::format::mmsi(entry_.mmsi));
+	field_rect = draw_field(painter, field_rect, s, "Ctry", ais::format::mid(entry_.mmsi));
 	field_rect = draw_field(painter, field_rect, s, "Name", entry_.name);
 	field_rect = draw_field(painter, field_rect, s, "Call", entry_.call_sign);
 	field_rect = draw_field(painter, field_rect, s, "Dest", entry_.destination);

firmware/application/apps/ais_app.hpp

@@ -131,11 +131,11 @@ private:
 	AISRecentEntry entry_ { };
 
 	Button button_done {
-		{ 125, 216, 96, 24 },
+		{ 125, 224, 96, 24 },
 		"Done"
 	};
 	Button button_see_map {
-		{ 19, 216, 96, 24 },
+		{ 19, 224, 96, 24 },
 		"See on map"
 	};
 	GeoMapView* geomap_view { nullptr };
@@ -169,6 +169,7 @@ private:
 	static constexpr uint32_t initial_target_frequency = 162025000;
 	static constexpr uint32_t sampling_rate = 2457600;
 	static constexpr uint32_t baseband_bandwidth = 1750000;
+
 	NavigationView& nav_;
 
 	AISRecentEntries recent { };

firmware/application/database.cpp

@@ -27,6 +27,16 @@
 
 namespace std {
 
+int database::retrieve_mid_record(MidDBRecord* record, std::string search_term){
+        
+	file_path = "AIS/mids.db";
+	index_item_length = 4;
+	record_length = 32;
+
+	result = std::database::retrieve_record(file_path, index_item_length, record_length, record, search_term);
+
+	return(result);
+}
 
 int database::retrieve_airline_record(AirlinesDBRecord* record, std::string search_term){
         

firmware/application/database.hpp

@@ -44,6 +44,12 @@ public:
 #define DATABASE_NOT_FOUND		-1		// database not found / could not be opened
 #define DATABASE_RECORD_NOT_FOUND	-2		// record could not be found in database
 
+	struct MidDBRecord {
+		char 	country[32];			// country name
+	};
+
+	int retrieve_mid_record(MidDBRecord* record, std::string search_term);
+
 	struct AirlinesDBRecord {
 		char 	airline[32];			// airline name
 		char 	country[32];			// country name

firmware/tools/make_mids_db/MaritimeIdentificationDigits.csv

@@ -0,0 +1,295 @@
+Digit,Allocated to
+201,Albania (Republic of)
+202,Andorra (Principality of)
+203,Austria
+204,Portugal - Azores
+205,Belgium
+206,Belarus (Republic of)
+207,Bulgaria (Republic of)
+208,Vatican City State
+209,Cyprus (Republic of)
+210,Cyprus (Republic of)
+211,Germany (Federal Republic of)
+212,Cyprus (Republic of)
+213,Georgia
+214,Moldova (Republic of)
+215,Malta
+216,Armenia (Republic of)
+218,Germany (Federal Republic of)
+219,Denmark
+220,Denmark
+224,Spain
+225,Spain
+226,France
+227,France
+228,France
+229,Malta
+230,Finland
+231,Denmark - Faroe Islands
+232,United Kingdom of Great Britain and Northern Ireland
+233,United Kingdom of Great Britain and Northern Ireland
+234,United Kingdom of Great Britain and Northern Ireland
+235,United Kingdom of Great Britain and Northern Ireland
+236,United Kingdom of Great Britain and Northern Ireland - Gibraltar
+237,Greece
+238,Croatia (Republic of)
+239,Greece
+240,Greece
+241,Greece
+242,Morocco (Kingdom of)
+243,Hungary
+244,Netherlands (Kingdom of the)
+245,Netherlands (Kingdom of the)
+246,Netherlands (Kingdom of the)
+247,Italy
+248,Malta
+249,Malta
+250,Ireland
+251,Iceland
+252,Liechtenstein (Principality of)
+253,Luxembourg
+254,Monaco (Principality of)
+255,Portugal - Madeira
+256,Malta
+257,Norway
+258,Norway
+259,Norway
+261,Poland (Republic of)
+262,Montenegro
+263,Portugal
+264,Romania
+265,Sweden
+266,Sweden
+267,Slovak Republic
+268,San Marino (Republic of)
+269,Switzerland (Confederation of)
+270,Czech Republic
+271,Turkey
+272,Ukraine
+273,Russian Federation
+274,North Macedonia (Republic of)
+275,Latvia (Republic of)
+276,Estonia (Republic of)
+277,Lithuania (Republic of)
+278,Slovenia (Republic of)
+279,Serbia (Republic of)
+301,United Kingdom of Great Britain and Northern Ireland - Anguilla
+303,United States of America - Alaska (State of)
+304,Antigua and Barbuda
+305,Antigua and Barbuda
+306,"Netherlands (Kingdom of the) - Bonaire, Sint Eustatius and Saba"
+306,Netherlands (Kingdom of the) - Curaçao
+306,Netherlands (Kingdom of the) - Sint Maarten (Dutch part)
+307,Netherlands (Kingdom of the) - Aruba
+308,Bahamas (Commonwealth of the)
+309,Bahamas (Commonwealth of the)
+310,United Kingdom of Great Britain and Northern Ireland - Bermuda
+311,Bahamas (Commonwealth of the)
+312,Belize
+314,Barbados
+316,Canada
+319,United Kingdom of Great Britain and Northern Ireland - Cayman Islands
+321,Costa Rica
+323,Cuba
+325,Dominica (Commonwealth of)
+327,Dominican Republic
+329,France - Guadeloupe (French Department of)
+330,Grenada
+331,Denmark - Greenland
+332,Guatemala (Republic of)
+334,Honduras (Republic of)
+336,Haiti (Republic of)
+338,United States of America
+339,Jamaica
+341,Saint Kitts and Nevis (Federation of)
+343,Saint Lucia
+345,Mexico
+347,France - Martinique (French Department of)
+348,United Kingdom of Great Britain and Northern Ireland - Montserrat
+350,Nicaragua
+351,Panama (Republic of)
+352,Panama (Republic of)
+353,Panama (Republic of)
+354,Panama (Republic of)
+355,Panama (Republic of)
+356,Panama (Republic of)
+357,Panama (Republic of)
+358,United States of America - Puerto Rico
+359,El Salvador (Republic of)
+361,France - Saint Pierre and Miquelon (Territorial Collectivity of)
+362,Trinidad and Tobago
+364,United Kingdom of Great Britain and Northern Ireland - Turks and Caicos Islands
+366,United States of America
+367,United States of America
+368,United States of America
+369,United States of America
+370,Panama (Republic of)
+371,Panama (Republic of)
+372,Panama (Republic of)
+373,Panama (Republic of)
+374,Panama (Republic of)
+375,Saint Vincent and the Grenadines
+376,Saint Vincent and the Grenadines
+377,Saint Vincent and the Grenadines
+378,United Kingdom of Great Britain and Northern Ireland - British Virgin Islands
+379,United States of America - United States Virgin Islands
+401,Afghanistan
+403,Saudi Arabia (Kingdom of)
+405,Bangladesh (People's Republic of)
+408,Bahrain (Kingdom of)
+410,Bhutan (Kingdom of)
+412,China (People's Republic of)
+413,China (People's Republic of)
+414,China (People's Republic of)
+416,China (People's Republic of) - Taiwan (Province of China)
+417,Sri Lanka (Democratic Socialist Republic of)
+419,India (Republic of)
+422,Iran (Islamic Republic of)
+423,Azerbaijan (Republic of)
+425,Iraq (Republic of)
+428,Israel (State of)
+431,Japan
+432,Japan
+434,Turkmenistan
+436,Kazakhstan (Republic of)
+437,Uzbekistan (Republic of)
+438,Jordan (Hashemite Kingdom of)
+440,Korea (Republic of)
+441,Korea (Republic of)
+443,"State of Palestine (In accordance with Resolution 99 Rev. Dubai, 2018)"
+445,Democratic People's Republic of Korea
+447,Kuwait (State of)
+450,Lebanon
+451,Kyrgyz Republic
+453,China (People's Republic of) - Macao (Special Administrative Region of China)
+455,Maldives (Republic of)
+457,Mongolia
+459,Nepal (Federal Democratic Republic of)
+461,Oman (Sultanate of)
+463,Pakistan (Islamic Republic of)
+466,Qatar (State of)
+468,Syrian Arab Republic
+470,United Arab Emirates
+471,United Arab Emirates
+472,Tajikistan (Republic of)
+473,Yemen (Republic of)
+475,Yemen (Republic of)
+477,China (People's Republic of) - Hong Kong (Special Administrative Region of China)
+478,Bosnia and Herzegovina
+501,France - Adelie Land
+503,Australia
+506,Myanmar (Union of)
+508,Brunei Darussalam
+510,Micronesia (Federated States of)
+511,Palau (Republic of)
+512,New Zealand
+514,Cambodia (Kingdom of)
+515,Cambodia (Kingdom of)
+516,Australia - Christmas Island (Indian Ocean)
+518,New Zealand - Cook Islands
+520,Fiji (Republic of)
+523,Australia - Cocos (Keeling) Islands
+525,Indonesia (Republic of)
+529,Kiribati (Republic of)
+531,Lao People's Democratic Republic
+533,Malaysia
+536,United States of America - Northern Mariana Islands (Commonwealth of the)
+538,Marshall Islands (Republic of the)
+540,France - New Caledonia
+542,New Zealand - Niue
+544,Nauru (Republic of)
+546,France - French Polynesia
+548,Philippines (Republic of the)
+550,Timor-Leste (Democratic Republic of)
+553,Papua New Guinea
+555,United Kingdom of Great Britain and Northern Ireland - Pitcairn Island
+557,Solomon Islands
+559,United States of America - American Samoa
+561,Samoa (Independent State of)
+563,Singapore (Republic of)
+564,Singapore (Republic of)
+565,Singapore (Republic of)
+566,Singapore (Republic of)
+567,Thailand
+570,Tonga (Kingdom of)
+572,Tuvalu
+574,Viet Nam (Socialist Republic of)
+576,Vanuatu (Republic of)
+577,Vanuatu (Republic of)
+578,France - Wallis and Futuna Islands
+601,South Africa (Republic of)
+603,Angola (Republic of)
+605,Algeria (People's Democratic Republic of)
+607,France - Saint Paul and Amsterdam Islands
+608,United Kingdom of Great Britain and Northern Ireland - Ascension Island
+609,Burundi (Republic of)
+610,Benin (Republic of)
+611,Botswana (Republic of)
+612,Central African Republic
+613,Cameroon (Republic of)
+615,Congo (Republic of the)
+616,Comoros (Union of the)
+617,Cabo Verde (Republic of)
+618,France - Crozet Archipelago
+619,Côte d'Ivoire (Republic of)
+620,Comoros (Union of the)
+621,Djibouti (Republic of)
+622,Egypt (Arab Republic of)
+624,Ethiopia (Federal Democratic Republic of)
+625,Eritrea
+626,Gabonese Republic
+627,Ghana
+629,Gambia (Republic of the)
+630,Guinea-Bissau (Republic of)
+631,Equatorial Guinea (Republic of)
+632,Guinea (Republic of)
+633,Burkina Faso
+634,Kenya (Republic of)
+635,France - Kerguelen Islands
+636,Liberia (Republic of)
+637,Liberia (Republic of)
+638,South Sudan (Republic of)
+642,Libya (State of)
+644,Lesotho (Kingdom of)
+645,Mauritius (Republic of)
+647,Madagascar (Republic of)
+649,Mali (Republic of)
+650,Mozambique (Republic of)
+654,Mauritania (Islamic Republic of)
+655,Malawi
+656,Niger (Republic of the)
+657,Nigeria (Federal Republic of)
+659,Namibia (Republic of)
+660,France - Reunion (French Department of)
+661,Rwanda (Republic of)
+662,Sudan (Republic of the)
+663,Senegal (Republic of)
+664,Seychelles (Republic of)
+665,United Kingdom of Great Britain and Northern Ireland - Saint Helena
+666,Somalia (Federal Republic of)
+667,Sierra Leone
+668,Sao Tome and Principe (Democratic Republic of)
+669,Eswatini (Kingdom of)
+670,Chad (Republic of)
+671,Togolese Republic
+672,Tunisia
+674,Tanzania (United Republic of)
+675,Uganda (Republic of)
+676,Democratic Republic of the Congo
+677,Tanzania (United Republic of)
+678,Zambia (Republic of)
+679,Zimbabwe (Republic of)
+701,Argentine Republic
+710,Brazil (Federative Republic of)
+720,Bolivia (Plurinational State of)
+725,Chile
+730,Colombia (Republic of)
+735,Ecuador
+740,United Kingdom of Great Britain and Northern Ireland - Falkland Islands (Malvinas)
+745,France - Guiana (French Department of)
+750,Guyana
+755,Paraguay (Republic of)
+760,Peru
+765,Suriname (Republic of)
+770,Uruguay (Eastern Republic of)
+775,Venezuela (Bolivarian Republic of)

firmware/tools/make_mids_db/README.md

@@ -0,0 +1,13 @@
+# Make mids.db
+
+Licensed under [GNU GPL v3](../../../LICENSE)
+
+Python3 script creates a MID (Marine Identification Digit) database.
+MID is part of MMSI and determines (among other things) the conutry. 
+
+
+USAGE:
+ - Copy Excel file from https://www.itu.int/en/ITU-R/terrestrial/fmd/Pages/mid.aspx
+ - Convert it to a csv document
+ - Run Python 3 script: `./make_mids_db.py` 
+ - Copy file to /AIS folder on SDCARD

firmware/tools/make_mids_db/make_mid_db.py

@@ -0,0 +1,55 @@
+#!/usr/bin/env python3
+
+# Copyright (C) 2022 ArjanOnwezen
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2, or (at your option)
+# any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; see the file COPYING.  If not, write to
+# the Free Software Foundation, Inc., 51 Franklin Street,
+# Boston, MA 02110-1301, USA.
+#
+
+# -------------------------------------------------------------------------------------
+# Create mids.db, used for AIS receiver application, using converted Excel file on page:
+# https://www.itu.int/en/ITU-R/terrestrial/fmd/Pages/mid.aspx
+# as a source.
+# MID stands for Marine Identification Digits and can be used to determine conutry of
+# vessel or coastal station.
+# -------------------------------------------------------------------------------------
+import csv
+import re
+import unicodedata
+mid_codes=bytearray()
+countries=bytearray()
+row_count=0
+
+database=open("mids.db", "wb")
+
+with open('MaritimeIdentificationDigits.csv', 'rt') as csv_file:
+        sorted_lines=sorted(csv_file.readlines())
+
+        for row in csv.reader(sorted_lines, quotechar='"', delimiter=',', quoting=csv.QUOTE_ALL, skipinitialspace=True):
+                mid_code=row[0]
+                # Normalize some unicode characters
+#unicodedata.normalize('NFKD', row[3][:32]).encode('ascii', 'ignore') 
+                country=unicodedata.normalize('NFKD', "".join(re.split("\(|\)|\[|\]", row[1].split('-')[-1].replace(" of Great Britain and Northern Ireland" , ""))[::2])).replace("Democratic People's Republic of Korea", "North-Korea").strip().encode('ascii', 'ignore')[:32]
+                if len(mid_code) == 3 :
+                        country_padding=bytearray()
+                        print(mid_code,' - ', country)
+                        mid_codes=mid_codes+bytearray(mid_code+'\0', encoding='ascii')
+                        country_padding=bytearray('\0' * (32 - len(country)), encoding='ascii')
+                        countries=countries+country+country_padding
+                        row_count+=1
+
+database.write(mid_codes+countries)
+print("Total of", row_count, "MID codes stored in database")
+