Skip to content

Commit

Permalink
adds changelog and update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
SebMeunier committed Jun 2, 2020
1 parent a30651b commit 4b5f62a
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 32 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<a name="1.0"></a># [1.0](https://github.com/intuiface/FaceDetectionIA/releases/tag/1.0) (2020-05-27)### Features* **UDP Communication Interface Asset:** * Receives data over UDP * Sends ASCII or HEX data over UDP
Expand Down
33 changes: 1 addition & 32 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1 @@
# UDP Communication Interface Asset for Intuiface

**Important**: This Interface Asset is only available for Player for Windows.

The UDP Communication enables to you send or receive message over UDP.
It is composed of

* 2 read-only properties
* Last message received
* Logs
* 1 trigger
* Message received. This trigger is raised with 1 parameter: Message.
* 3 actions:
* Start listening: You need to call this action to start listening on a dedicated UDP port
* Send message: sends an ASCII message to specified address and port
* Send hex message: sends an Hexadecimal message to specified address and port

## How to use the UDP Communication Interface Asset

To add a Face UDP Communication Interface Asset into an Intuiface experience, follow these steps:

* Close all running instances of **Intuiface Composer**.
* Download the [latest released package here](https://github.com/intuiface/UDPCommunicationIA/releases).
* Extract the archive and copy the **UDPCommunicationIA** folder to the path "[Drive]:\Users\\[UserName]\Documents\Intuiface\Interface Assets".
* Launch **Intuiface Composer** and open your project.
* Open the Interface Asset panel and select the **Add an Interface Asset** option. When you enter "UDP" in the search bar, you should see the **UDPCommunication** Interface Asset.

## License

Copyright © 2020 Intuiface.

Released under the MIT License.
# UDP Communication Interface Asset for Intuiface**Important**: This Interface Asset is only available for **Player for Windows**. The UDP Communication enables to you send or receive message over UDP. It is composed of * 2 read-only properties * Last message received * Logs* 1 trigger * Message received. This trigger is raised with 1 parameter: Message. * 3 actions: * Start listening: You need to call this action to start listening on a dedicated UDP port * Send message: sends an ASCII message to specified address and port * Send hex message: sends an Hexadecimal message to specified address and port ## How to use the UDP Communication Interface AssetTo add a Face UDP Communication Interface Asset into an Intuiface experience, follow these steps:* Close all running instances of **Intuiface Composer**.* Download the [latest released package here](https://github.com/intuiface/UDPCommunicationIA/releases).* Extract the archive and copy the **UDPCommunicationIA** folder to the path "[Drive]:\Users\\[UserName]\Documents\Intuiface\Interface Assets".* Launch **Intuiface Composer** and open your project.* Open the Interface Asset panel and select the **Add an Interface Asset** option. When you enter "UDP" in the search bar, you should see the **UDPCommunication** Interface Asset.## LicenseCopyright © 2020 Intuiface.Released under the MIT License.
Expand Down

0 comments on commit 4b5f62a

Please sign in to comment.