holado 0.13.22__py3-none-any.whl

holado-0.13.22.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any

holado-0.13.22.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 by Eric Klumpp
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

holado_ais/__init__.py

@@ -0,0 +1,33 @@
+# -*- coding: utf-8 -*-
+
+#################################################
+# HolAdo (Holistic Automation do)
+#
+# (C) Copyright 2021-2025 by Eric Klumpp
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+# The Software is provided “as is”, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the Software.
+#################################################
+
+
+def dependencies():
+    return None
+
+def register():
+    from holado.common.context.session_context import SessionContext
+    
+    from holado_ais.ais.ais_messages import AISMessages
+    if AISMessages.is_available():
+        SessionContext.instance().services.register_service_type("ais_messages", AISMessages)
+    
+    from holado_ais.ais.ais_manager import AISManager
+    SessionContext.instance().services.register_service_type("ais_manager", AISManager,
+                            lambda m: m.initialize(SessionContext.instance().resource_manager) )
+
+
+
+
+

holado_ais/ais/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,Republic of Türkiye
+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)

holado_ais/ais/ais_manager.py

@@ -0,0 +1,151 @@
+
+#################################################
+# HolAdo (Holistic Automation do)
+#
+# (C) Copyright 2021-2025 by Eric Klumpp
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+# The Software is provided “as is”, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the Software.
+#################################################
+
+import logging
+from holado_core.common.resource.persisted_data_manager import PersistedDataManager
+import os
+from holado_python.standard_library.csv import CsvManager
+from holado_core.common.exceptions.technical_exception import TechnicalException
+
+logger = logging.getLogger(__name__)
+
+
+class AISManager(object):
+    
+    def __init__(self):
+        self.__persisted_data_manager = PersistedDataManager(data_name="AIS data",
+                                                             table_name=self.__get_persisted_data_table_name(),
+                                                             table_sql_create=self.__get_persisted_data_table_sql_create(),
+                                                             db_name="ais")
+        self.__possible_mids = []
+        
+    def initialize(self, resource_manager):
+        self.__persisted_data_manager.initialize(resource_manager)
+        
+        self.__possible_mids = self.__load_mids()
+    
+    def __load_mids(self):
+        """Return possible MID (Maritime Identification Digits) values.
+        Resource file MaritimeIdentificationDigits.csv is an export from https://www.itu.int/en/ITU-R/terrestrial/fmd/Pages/mid.aspx
+        """
+        here = os.path.abspath(os.path.dirname(__file__))
+        path = os.path.normpath(os.path.join(here, "MaritimeIdentificationDigits.csv"))
+        
+        table = CsvManager.table_with_content_of_CSV_file(path, delimiter=',')
+        return table.get_column(name='Digit').cells_content
+    
+    def new_unique_mmsi_number(self):
+        # Ensure persistent DB exists
+        self.__persisted_data_manager.ensure_persistent_db_exists()
+        
+        last_mmsi = self.__get_persisted_data_value("unique_mmsi")
+        res = self.next_valid_mmsi(last_mmsi)
+        if res is None:
+            # This case appears when last unique MMSI was last valid MMSI. Get first possible MMSI.
+            res = self.next_valid_mmsi(None)
+            
+        self.__update_or_add_persisted_data("unique_mmsi", res)
+        
+        return res
+    
+    def format_mmsi_number_as_string(self, mmsi):
+        if not isinstance(mmsi, int):
+            raise TechnicalException(f"MMSI is not an integer (obtained type: {type(mmsi)})")
+        return f"{mmsi:09d}"
+
+    def first_valid_mmsi(self):
+        return int(self.__possible_mids[0]) * 10000
+    
+    def next_valid_mmsi(self, previous_mmsi=None):
+        """Return next valid MMSI.
+        
+        Notes:
+            If previous_mmsi is None, return first valid MMSI number.
+            If previous_mmsi is last valid MMSI, return None.
+        """
+        if previous_mmsi is None:
+            # Return smallest possible MMSI
+            return self.first_valid_mmsi()
+        else:
+            for mmsi in range(previous_mmsi+1, int(1e9)):
+                if self.is_valid_mmsi(mmsi):
+                    return mmsi
+            return None
+    
+    def is_valid_mmsi(self, mmsi):
+        """Return if MMSI is valid
+        The MMSI uniquely identifies a ship (or a group of ships), or a coast radio station.
+        MMSI stands for Maritime Mobile Service Identity.
+        Possible values:
+        * 97<nnnnnnn>: valid
+        * [00|98|99]<MID><nnnn> : valid if MID is valid
+        * [0|8]<MID><nnnnn> : valid if MID is valid
+        * <MID><nnnnnn> : valid if MID is valid
+        * <any other value (incl. > 999999999) : invalid
+        @param mmsi: MMSI to validate (type: int, str)
+        """
+        if mmsi is None:
+            return False
+        
+        if isinstance(mmsi, int):
+            mmsi = self.format_mmsi_number_as_string(mmsi)
+        if mmsi[0:2] in ['97', '99']:
+            return True
+        else:
+            if mmsi[0:2] in ['00', '98', '99']:
+                mid = mmsi[2:5]
+            elif mmsi[0:1] in ['0', '8']:
+                mid = mmsi[1:4]
+            else:
+                mid = mmsi[0:3]
+            return self.is_valid_mid(mid)
+    
+    def is_valid_mid(self, mid):
+        return mid in self.__possible_mids
+
+    def __next_mid(self, previous_mid):
+        """Return next MID in possible MID values"""
+        if previous_mid is None:
+            return self.__possible_mids[0]
+        elif previous_mid in self.__possible_mids:
+            index = self.__possible_mids.index(previous_mid)
+            if index + 1 < len(self.__possible_mids):
+                return self.__possible_mids[index+1]
+            else:
+                return None
+        else:
+            raise TechnicalException(f"MID {previous_mid} is not valid")
+
+    # Manage persistent data
+
+    def __get_persisted_data_table_name(self):
+        return "ais_data"
+
+    def __get_persisted_data_table_sql_create(self):
+        return """CREATE TABLE ais_data (
+                key text NOT NULL,
+                value text
+            )"""
+
+    def __update_or_add_persisted_data(self, key, value):
+        self.__persisted_data_manager.update_or_add_persisted_data(persisted_filter_data={'key':key}, data={'value':value})
+
+    def __get_persisted_data_value(self, key):
+        persisted_data = self.__persisted_data_manager.get_persisted_data(filter_data={'key':key})
+        if persisted_data is not None:
+            return int(persisted_data['value'])
+        else:
+            return None
+        
+
+