diff --git a/python/aisStream/docs/PositionReport.md b/python/aisStream/docs/PositionReport.md index 22bf269..1ee939d 100644 --- a/python/aisStream/docs/PositionReport.md +++ b/python/aisStream/docs/PositionReport.md @@ -4,23 +4,23 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**message_id** | **int** | | -**repeat_indicator** | **int** | | -**user_id** | **int** | | +**message_id** | **int** | Identifier for this message 1, 2 or 3 | +**repeat_indicator** | **int** | Used by the repeater to indicate how many times a message has been repeated. See § 4.6.1, Annex 2; 0-3; 0 = default; 3 = do not repeat any more | +**user_id** | **int** | Unique identifier such as MMSI number | **valid** | **bool** | | -**navigational_status** | **int** | | -**rate_of_turn** | **int** | | -**sog** | **float** | | -**position_accuracy** | **bool** | | -**longitude** | **float** | | -**latitude** | **float** | | -**cog** | **float** | | -**true_heading** | **int** | | -**timestamp** | **int** | | -**special_manoeuvre_indicator** | **int** | | -**spare** | **int** | | -**raim** | **bool** | | -**communication_state** | **int** | | +**navigational_status** | **int** | 0 = under way using engine; 1 = at anchor; 2 = not under command; 3 = restricted maneuverability; 4 = constrained by her draught; 5 = moored; 6 = aground; 7 = engaged in fishing; 8 = under way sailing; 9 = reserved for future amendment of navigational status for ships carrying DG, HS, or MP, or IMO hazard or pollutant category C, high speed craft (HSC); 10 = reserved for future amendment of navigational status for ships carrying dangerous goods (DG), harmful substances (HS) or marine pollutants (MP), or IMO hazard or pollutant category A, wing in ground (WIG); 11 = power-driven vessel towing astern (regional use); 12 = power-driven vessel pushing ahead or towing alongside (regional use); 13 = reserved for future use; 14 = AIS-SART (active), MOB-AIS, EPIRB-AIS; 15 = undefined = default (also used by AIS-SART, MOB-AIS and EPIRB-AIS under test) | +**rate_of_turn** | **int** | 0 to +126 = turning right at up to 708° per min or higher; 0 to –126 = turning left at up to 708° per min or higher; Values between 0 and 708° per min coded by ROTAIS = 4.733 SQRT(ROTsensor) degrees per min where ROTsensor is the Rate of Turn as input by an external Rate of Turn Indicator (TI). ROTAIS is rounded to the nearest integer value. +127 = turning right at more than 5° per 30 s (No TI available); –127 = turning left at more than 5° per 30 s (No TI available); –128 (80 hex) indicates no turn information available (default). ROT data should not be derived from COG information. | +**sog** | **float** | Speed over ground in 1/10 knot steps (0-102.2 knots); 1023 = not available; 1022 = 102.2 knots or higher. | +**position_accuracy** | **bool** | The position accuracy (PA) flag should be determined in accordance with Table 50; 1 = high (≤10 m); 0 = low (>10 m); 0 = default. | +**longitude** | **float** | Longitude in 1/10 000 min (±180°, East = positive (as per 2’s complement), West = negative (as per 2’s complement). 181 = (6791AC0h) = not available = default) | +**latitude** | **float** | Latitude in 1/10 000 min (±90°, North = positive (as per 2 ’s complement), South = negative (as per 2’s complement). 91° (3412140h) = not available = default) | +**cog** | **float** | Course over ground in 1/10 = (0-3599). 3600 (E10h) = not available = default. 3601-4095 should not be used | +**true_heading** | **int** | Degrees (0-359) (511 indicates not available = default) | +**timestamp** | **int** | UTC second when the report was generated by the electronic position system (EPFS) (0-59, or 60 if time stamp is not available, which should also be the default value, or 61 if positioning system is in manual input mode, or 62 if electronic position fixing system operates in estimated (dead reckoning) mode, or 63 if the positioning system is inoperative) | +**special_manoeuvre_indicator** | **int** | 0 = not available = default; 1 = not engaged in special manoeuvre; 2 = engaged in special manoeuvre (i.e. regional passing arrangement on Inland Waterway) | +**spare** | **int** | Not used. Should be set to zero. Reserved for future use. | +**raim** | **bool** | Receiver autonomous integrity monitoring (RAIM) flag of electronic position fixing device; 0 = RAIM not in use = default; 1 = RAIM in use. See Table 50 | +**communication_state** | **int** | See Table 49 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)