-
Notifications
You must be signed in to change notification settings - Fork 65
/
Copy pathCHANGELOG.txt
327 lines (283 loc) · 16.3 KB
/
CHANGELOG.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
====================
pyais CHANGELOG
====================
-------------------------------------------------------------------------------
Version 2.8.4 26 Jan 2025
-------------------------------------------------------------------------------
* closes #161: https://github.com/M0r13n/pyais/issues/161
* adds property `full_name` to message type 21
-------------------------------------------------------------------------------
Version 2.8.3 20 Dec 2024
-------------------------------------------------------------------------------
* closes #157: https://github.com/M0r13n/pyais/issues/157
* pyais now handles framgmented messages where at least one fragment has an empty payload gracefully
* added a new exception `MissingPayloadException`
* raised if the assembled payload is empty
-------------------------------------------------------------------------------
Version 2.8.2 11 Nov 2024
-------------------------------------------------------------------------------
* closes #154: https://github.com/M0r13n/pyais/issues/154
* enums now return their underlying value when converted using `__str__()`
-------------------------------------------------------------------------------
Version 2.8.1 19 Oct 2024
-------------------------------------------------------------------------------
* closes #153: https://github.com/M0r13n/pyais/pull/153
-------------------------------------------------------------------------------
Version 2.8.0 21 Sep 2024
-------------------------------------------------------------------------------
* closes #150: NMEA tag blocks (thanks to @Leila-Codes)
* adds TagBlockQueue: rudimentary support for NMEA tag block grouping
-------------------------------------------------------------------------------
Version 2.7.2 19 Aug 2024
-------------------------------------------------------------------------------
* removes `reuse` for TCP/UDP sockets
-------------------------------------------------------------------------------
Version 2.7.1 17 Aug 2024
-------------------------------------------------------------------------------
* exposes `close()` for TCP/UDP sockets (@mib1185)
-------------------------------------------------------------------------------
Version 2.7.0 27 Jul 2024
-------------------------------------------------------------------------------
* adds the `PreprocessorProtocol` to support custom message formats
* DROPS support for Python 3.7 (EOL)
* minor correction in the documentation (thanks to @lsamaciel)
-------------------------------------------------------------------------------
Version 2.6.6 26 Jun 2024
-------------------------------------------------------------------------------
* improves the API of `FilterChain`
* `FilterChain.filter(stream)` now accepts a stream instance
* this stream MUST implement the `Stream` interface defined in pyais.stream
* individual messages can be filtered using `IterMessages(...)`
-------------------------------------------------------------------------------
Version 2.6.5 10 May 2024
-------------------------------------------------------------------------------
* merges https://github.com/M0r13n/pyais/pull/135 (by @prefixFelix)
* fixed the length of the UTC hour and minute field
* closes https://github.com/M0r13n/pyais/issues/136
* resolved logic error to accurately distinguish between SOTDMA and ITDMA communication states
-------------------------------------------------------------------------------
Version 2.6.4 27 Apr 2024
-------------------------------------------------------------------------------
* merges https://github.com/M0r13n/pyais/pull/134 (by @alfonnews)
* adds additional fields to `AISTrack`
-------------------------------------------------------------------------------
Version 2.6.3 05 Apr 2024
-------------------------------------------------------------------------------
* closes https://github.com/M0r13n/pyais/issues/131
* pyais now supports country codes/names using `get_country(mmsi)`
-------------------------------------------------------------------------------
Version 2.6.2 16 Mar 2024
-------------------------------------------------------------------------------
* fixes inconsistent rounding behavior for ROT values
* https://github.com/M0r13n/pyais/pull/130
-------------------------------------------------------------------------------
Version 2.6.1 20 Jan 2024
-------------------------------------------------------------------------------
* fixes a logic bug in `NoneFilter`
* https://github.com/M0r13n/pyais/issues/128
-------------------------------------------------------------------------------
Version 2.6.0 28 Dec 2023
-------------------------------------------------------------------------------
* Initial release of the AIS Filters system.
* Basic filtering classes: `NoneFilter`, `MessageTypeFilter`, and `DistanceFilter`.
* `FilterChain` class to combine multiple filters into a sequence.
* Utility functions `haversine` and `is_in_grid` for distance and grid calculations.
-------------------------------------------------------------------------------
Version 2.5.9 26 Nov 2023
-------------------------------------------------------------------------------
* adds `decode_nmea_and_ais`
* use this method to get a tuple of NMEASentence and AIS payload
* chore: also adds another example regarding tag blocks
-------------------------------------------------------------------------------
Version 2.5.8 01 Oct 2023
-------------------------------------------------------------------------------
* bug fix: Navigational statuses 9, 10, 13 and Ship type 29
* closes https://github.com/M0r13n/pyais/issues/123
* adds Navigational statuses 9, 10, 13 to NavigationStatus
* adds Ship type 29 to ShipType
-------------------------------------------------------------------------------
Version 2.5.7 29 Jul 2023
-------------------------------------------------------------------------------
* bug fix: EpfdType Enum Missing InternalGNSS
* closes https://github.com/M0r13n/pyais/issues/121
-------------------------------------------------------------------------------
Version 2.5.6 29 Jul 2023
-------------------------------------------------------------------------------
* bug fix: lazily yield file-like objects by removing `.readlines()`
* closes https://github.com/M0r13n/pyais/pull/119
-------------------------------------------------------------------------------
Version 2.5.5 16 Jun 2023
-------------------------------------------------------------------------------
* bug fix: incorrect logic for type 26 messages
* closes https://github.com/M0r13n/pyais/issues/116
-------------------------------------------------------------------------------
Version 2.5.4 30 May 2023
-------------------------------------------------------------------------------
* bug fix: the streaming classes previously prepended partial lines to subsequent lines
-------------------------------------------------------------------------------
Version 2.5.3 27 May 2023
-------------------------------------------------------------------------------
* bug fix: the streaming classes now handle universal line breaks
* user reported issues while receiving AIS messages through a socket
* pyais assumed that lines are always terminated with CRLF
* now pyais supports both CRLF as well as LF as line breaks
-------------------------------------------------------------------------------
Version 2.5.2 04 Mar 2023
-------------------------------------------------------------------------------
* closes https://github.com/M0r13n/pyais/issues/100
* updated Aid to Navigation dict (NavAid)
-------------------------------------------------------------------------------
Version 2.5.1 26 Feb 2023
-------------------------------------------------------------------------------
* closes https://github.com/M0r13n/pyais/issues/107
* fixes a rounding error for lat/lon values
-------------------------------------------------------------------------------
Version 2.5.0 14 Jan 2023
-------------------------------------------------------------------------------
* introduce `AISracker` class
* adds the ability to collect and maintain the state of individual vessels over time
* closes https://github.com/M0r13n/pyais/pull/103
* allows tag blocks to contain multiple : in field data
-------------------------------------------------------------------------------
Version 2.4.0 21 Dec 2022
-------------------------------------------------------------------------------
* supports optional tag blocks for NMEA messages
-------------------------------------------------------------------------------
Version 2.3.1 17 Dec 2022
-------------------------------------------------------------------------------
* closes https://github.com/M0r13n/pyais/issues/94
* removed unnecessary padding (`@`) from variable length text/data fields
* introduced a new keyword `variable_length` to the `bit_field` method:
* boolean value that defaults to `False`
* marks fields as variable in length (width)
* used by the encoder to decide whether to add trailing `@`s as padding
-------------------------------------------------------------------------------
Version 2.3.0 11 Dec 2022
-------------------------------------------------------------------------------
* closes https://github.com/M0r13n/pyais/issues/91
* supports Gatehouse wrappers used to add extra information
* renames `NMEAMessage` to `NMEASentence`
-------------------------------------------------------------------------------
Version 2.2.4 11 Nov 2022
-------------------------------------------------------------------------------
* ignores `NonPrintableCharacterException` exceptions when using stream readers
* such messages are simply skipped
-------------------------------------------------------------------------------
Version 2.2.3 04 Nov 2022
-------------------------------------------------------------------------------
* Closes https://github.com/M0r13n/pyais/issues/88
* make the decoder more liberal by not raising an exception when the payload contains special characters
* replace the `ValueError` with a `NonPrintableCharacterException` in case that non printable characters are passed to the decode function
-------------------------------------------------------------------------------
Version 2.2.2 13 Oct 2022
-------------------------------------------------------------------------------
* Closes https://github.com/M0r13n/pyais/issues/86
* ensure that the payload is always identical - even for multiple encode/decode roundtrips
* the `turn` field can now never be `None` and is instead an instance of the newly created `TurnRate` enum
-------------------------------------------------------------------------------
Version 2.2.1 03 Oct 2022
-------------------------------------------------------------------------------
* Closes https://github.com/M0r13n/pyais/issues/81
* ensure that the NMEA sentence length does not exceed 82 characters
-------------------------------------------------------------------------------
Version 2.2.0 02 Oct 2022
-------------------------------------------------------------------------------
* Closes https://github.com/M0r13n/pyais/issues/82
* introduces optional error_if_checksum_invalid keyword (default=False)
* adds the possibility to raise an exception if the checksum is invalid
-------------------------------------------------------------------------------
Version 2.1.2 14 May 2022
-------------------------------------------------------------------------------
* Closes https://github.com/M0r13n/pyais/issues/17
* decoded `radio state` fields
* provided functions to access SOTDMA/ITDMA communication state information
-------------------------------------------------------------------------------
Version 2.1.1 24 Apr 2022
-------------------------------------------------------------------------------
* Closes https://github.com/M0r13n/pyais/issues/65
* makes lat and lon signed for type 27 messages
* drops nosetest as a development dependency
-------------------------------------------------------------------------------
Version 2.1.0 14 Apr 2022
-------------------------------------------------------------------------------
* Closes https://github.com/M0r13n/pyais/issues/63#issuecomment-1099045541
* unifies naming of fields across all message types
* makes all single bit fields booleans
* replaces the raw turn value with the actual rate of turn: (turn/4.733)**2
* makes all data fields raw bytes instead of (large) integers for interoperability
* makes speed and course floats instead of ints
* enforces strict types and fixes typing inconsistencies
-------------------------------------------------------------------------------
Version 2.0.3 27 Mar 2022
-------------------------------------------------------------------------------
* Closes https://github.com/M0r13n/pyais/issues/54
* for some fields like speed, lat or lon their types were not properly
enforced. This led to typing errors and wrong values, e.g. `0` instead
of `0.0`.
* Closes https://github.com/M0r13n/pyais/issues/59
* when encoding messages the underlying method `int_to_bin` incorrectly
assumed that all values were signed. This was wrong and could lead to
invalid messages, when encoding.
* Closes https://github.com/M0r13n/pyais/issues/58
* A missing checksum caused a `ValueError`, which is now ignored
-------------------------------------------------------------------------------
Version 2.0.2 20 Mar 2022
-------------------------------------------------------------------------------
* Closes https://github.com/M0r13n/pyais/issues/55
* Makes the attribute `raim` always an boolean
* Closes https://github.com/M0r13n/pyais/issues/54
* Ensure that the attributes speed, lat, lon and course are always `float`
-------------------------------------------------------------------------------
Version 2.0.1 6 Feb 2022
-------------------------------------------------------------------------------
* Closes https://github.com/M0r13n/pyais/issues/52
* renames shipname to name for type 21
-------------------------------------------------------------------------------
Version 2.0.0-alpha 6 Feb 2022
-------------------------------------------------------------------------------
* WARNING: The v2 release will introduce breaking changes
* Introduces the possibility to encode messages
* decoding has been rewritten and implements an iterative decoding approach
* The following fields were renamed:
* message_fragments -> frag_cnt
* fragment_number -> frag_num
* message_id -> seq_id
* type -> msg_type
* shiptype -> ship_type
* `msg.decode()` does not return a `pyais.messages.AISMessage` instance anymore
* instead an instance of `pyais.messages.MessageTypeX` is returned, where `X` is the type of the message (1-27)
* in v1 you called `decoded.content` to get the decoded message as a dictionary - this is now `decoded.asdict()`
-------------------------------------------------------------------------------
Version 1.6.2 2 May 2021
-------------------------------------------------------------------------------
* Improves `decode_msg` by adding meaningful error messages
-------------------------------------------------------------------------------
Version 1.6.0 2 May 2021
-------------------------------------------------------------------------------
* Makes `NMEAMessage` subscribable
* Adds documentation on readthedocs.org
* Renames instance attributes of `NMEAMessage`:
- msg_type to type
- count to message_fragments
- index to fragment_number
- seq_id to message_id
- data to payload#
* Adds fill_bits field to NMEAMessage
-------------------------------------------------------------------------------
Version 1.4.0 6 Mar 2021
-------------------------------------------------------------------------------
* Pyais comes with a commandline utility now
- `ais-decode` can decode single messages or files
- you can read from a TCP/UDP socket from the terminal
- no need to write Python code
* Improves Socket API
-------------------------------------------------------------------------------
Version 1.3.1 2 Jan 2021
-------------------------------------------------------------------------------
* Simple bug fix
- Store `mothership_mmsi` as 9-digit string
-------------------------------------------------------------------------------
Version 1.3.0 2 Jan 2021
-------------------------------------------------------------------------------
* Major API changes
- MMSI is stored as string with leading zeros (up to 9 chars) (#6)