Skip to content

Update transport docs for location suffix (Revision D) #50

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
felipefdl merged 2 commits into from
Apr 6, 2026
Merged

Update transport docs for location suffix (Revision D) #50

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
090a0d1
docs: update transport docs for TagoTiP Revision D location suffix
FabianoEger Apr 6, 2026
ca37a54
style: fix oxfmt formatting in transport docs
FabianoEger Apr 6, 2026
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
2 changes: 1 addition & 1 deletion docs/tagotip/introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ Learn more in the [Encryption](./specification/encryption) guide.
Push a temperature reading with unit, timestamp, and metadata - all in one frame:

```
PUSH|4deedd7bab8817ec|sensor-01|@1694567890000^batch_42{firmware=2.1}[temperature:=32.5#C;position@=39.74,-104.99]
PUSH|4deedd7bab8817ec|sensor-01|@=39.74,-104.99@1694567890000^batch_42{firmware=2.1}[temperature:=32.5#C]
```

Pull the last value back:
Expand Down
4 changes: 2 additions & 2 deletions docs/tagotip/transports/http.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ curl -X POST https://http.tip.us-e1.tago.io/v1/tip/sensor-01 \
curl -X POST https://http.tip.us-e1.tago.io/v1/tip/sensor-01 \
-H "Authorization: TagoTiP 4deedd7bab8817ec" \
-H "Content-Type: text/plain" \
-d '@1694567890000^batch_01{firmware=2.1}[temperature:=25.5#C;humidity:=60#%]'
-d '@=39.74,-104.99@1694567890000^batch_01{firmware=2.1}[temperature:=25.5#C;humidity:=60#%]'
```

### Push location data
Expand All @@ -131,7 +131,7 @@ curl -X POST https://http.tip.us-e1.tago.io/v1/tip/sensor-01 \
curl -X POST https://http.tip.us-e1.tago.io/v1/tip/tracker-01 \
-H "Authorization: TagoTiP 4deedd7bab8817ec" \
-H "Content-Type: text/plain" \
-d '[position@=39.74,-104.99,1609;speed:=45.2#km/h]'
-d '[position@=39.74,-104.99,1609;speed:=45.2#km/h@=39.74,-104.99]'
```

### Push raw payload (passthrough)
Expand Down
5 changes: 3 additions & 2 deletions docs/tagotip/transports/mqtt.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ Structured variables or passthrough:

```
[temp:=32#C;humidity:=65#%]
@1694567890000^batch_42[temp:=32#C]
@=39.74,-104.99@1694567890000^batch_42[temp:=32#C]
>xDEADBEEF01020304
>b3q2+7wECAwQ=
!42|[temp:=32#C;humidity:=65#%]
Expand Down Expand Up @@ -258,11 +258,12 @@ Append after the value, in this order:
| Suffix | Prefix | Example |
| --------- | ------ | --------------------------------- |
| Unit | `#` | `temperature:=25.5#C` |
| Location | `@=` | `speed:=10@=39.74,-104.99` |
| Timestamp | `@` | `temperature:=25.5@1694567890000` |
| Group | `^` | `temperature:=25.5^batch_01` |
| Metadata | `{}` | `temperature:=25.5{source=dht22}` |

All combined: `temperature:=25.5#C@1694567890000^batch_01{source=dht22,quality=high}`
All combined: `temperature:=25.5#C@=39.74,-104.99@1694567890000^batch_01{source=dht22,quality=high}`

## Response codes

Expand Down
3 changes: 2 additions & 1 deletion docs/tagotip/transports/tcp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,11 +204,12 @@ Append after the value, in this order:
| Suffix | Prefix | Example |
| --------- | ------ | --------------------------------- |
| Unit | `#` | `temperature:=25.5#C` |
| Location | `@=` | `speed:=10@=39.74,-104.99` |
| Timestamp | `@` | `temperature:=25.5@1694567890000` |
| Group | `^` | `temperature:=25.5^batch_01` |
| Metadata | `{}` | `temperature:=25.5{source=dht22}` |

All combined: `temperature:=25.5#C@1694567890000^batch_01{source=dht22,quality=high}`
All combined: `temperature:=25.5#C@=39.74,-104.99@1694567890000^batch_01{source=dht22,quality=high}`

## Response codes

Expand Down
5 changes: 3 additions & 2 deletions docs/tagotip/transports/udp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ ACK|OK|3
### Push location data

```bash
echo -n 'PUSH|4deedd7bab8817ec|tracker-01|[position@=39.74,-104.99,1609;speed:=45.2#km/h]' \
echo -n 'PUSH|4deedd7bab8817ec|tracker-01|[position@=39.74,-104.99,1609;speed:=45.2#km/h@=39.74,-104.99]' \
| nc -u -w1 udp.tip.us-e1.tago.io 5683
```

Expand Down Expand Up @@ -169,11 +169,12 @@ Append after the value, in this order:
| Suffix | Prefix | Example |
| --------- | ------ | --------------------------------- |
| Unit | `#` | `temperature:=25.5#C` |
| Location | `@=` | `speed:=10@=39.74,-104.99` |
| Timestamp | `@` | `temperature:=25.5@1694567890000` |
| Group | `^` | `temperature:=25.5^batch_01` |
| Metadata | `{}` | `temperature:=25.5{source=dht22}` |

All combined: `temperature:=25.5#C@1694567890000^batch_01{source=dht22,quality=high}`
All combined: `temperature:=25.5#C@=39.74,-104.99@1694567890000^batch_01{source=dht22,quality=high}`

## Response codes

Expand Down
Loading