Skip to content

Commit

Permalink
README update
Browse files Browse the repository at this point in the history
  • Loading branch information
PrimeGoose committed Jun 30, 2022
1 parent 7e935b0 commit 8d23f29
Show file tree
Hide file tree
Showing 4 changed files with 45 additions and 1 deletion.
44 changes: 44 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,50 @@ If you cannot find the information that you require then please contact the team
DISCLAIMER: “This information is being provided under license from EA for reference purposes only and we do not make any representations or warranties about the accuracy or reliability of the information for any specific purpose.”



## forwarding
> you can forward the udp data to your laptop, phone or any other other device for development or other consumption
```
npx f1-22-udp --forward 192.168.88.114:20777 192.168.88.200:20777
```


## logging
> you can log the parsed data to the console using any of the packet id's
```
npx f1-22-udp --log 0 1 2 3 4 5 6 7 8 9 10 11
```

## Installing

```
npm install f1-22-udp
```


## Usage

```ts
import { F122UDP } from "f1-22-udp";
/*
* 'port' is optional, defaults to 20777
* 'address' is optional, defaults to localhost
*/

const f122: F122UDP = new F122UDP();
f122.start();
// motion 0
client.on('motion',function(data) {
console.log(data);
})
```

![](./usage.png)




## Contents

* Overview 1
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "f1-22-udp",
"version": "1.0.0",
"version": "1.1.0",
"main": "build/src/F1_22_UDP.js",
"types": "build/src/F1_22_UDP.d.ts",
"files": [
Expand Down
Binary file modified udp_reveal.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added usage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8d23f29

Please sign in to comment.