Skip to content

doc updates #181

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
M0r13n merged 1 commit into from
Jun 16, 2025
Merged

doc updates #181

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,13 +50,13 @@ This AIS sentence is known as a "Position Report" message and is used to transmi
- : This field is left blank. This field can contain the sequence number.
- **B**: This field indicates the communication channel being used to transmit the message. In this case, the channel is "B".
- **15MwkT1P37G?fl0EJbR0OwT0@MS**: This field contains the payload of the message, which is encoded using a variant of ASCII known as "Six-bit ASCII". The payload contains information such as the vessel's identification, position, course, and speed.
0\*4E: This field is a checksum that is used to verify the integrity of the sentence.
- **0\*4E**: This field is a checksum that is used to verify the integrity of the sentence.

**pyais** is a Python modul to encode and decode AIS messages.
**pyais** is a Python module to encode and decode AIS messages.

# Installation

The project is available at Pypi:
The project is available at [PyPI](https://pypi.org/project/pyais/) and can be installed with pip:

```shell
$ pip install pyais
Expand Down Expand Up @@ -267,7 +267,7 @@ Regarding the key value pairs:
- **n**: Line count (e.g. `123`)
- **r**: Relative time
- **s**: Source station (e.g. `APIDSSRC1`)
- **t**: Text (e.g.g `Hello World!`)
- **t**: Text (e.g. `Hello World!`)

Some things to keep in mind when working with **tag blocks** and **pyais**:

Expand Down