diff --git a/README.md b/README.md index b8dac98..7257018 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/package.json b/package.json index 4704ce8..646b1b1 100644 --- a/package.json +++ b/package.json @@ -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": [ diff --git a/udp_reveal.jpg b/udp_reveal.jpg index 59bb3a3..410b7d1 100644 Binary files a/udp_reveal.jpg and b/udp_reveal.jpg differ diff --git a/usage.png b/usage.png new file mode 100644 index 0000000..8abb79d Binary files /dev/null and b/usage.png differ