https://github.com/asterics/asterics-networkio-websocket
This is an example of the AsTeRICS websocket functionality.
https://github.com/asterics/asterics-networkio-websocket
accessibility ape assistive-technology demo example websocket
Last synced: 6 days ago
JSON representation
This is an example of the AsTeRICS websocket functionality.
- Host: GitHub
- URL: https://github.com/asterics/asterics-networkio-websocket
- Owner: asterics
- Created: 2018-01-11T09:44:17.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-04-20T19:32:43.000Z (about 8 years ago)
- Last Synced: 2025-07-31T07:51:24.458Z (11 months ago)
- Topics: accessibility, ape, assistive-technology, demo, example, websocket
- Language: JavaScript
- Homepage: http://asterics.github.io/AsTeRICS/demos.html#WebSocket
- Size: 140 KB
- Stars: 0
- Watchers: 8
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# AsTeRICS Websocket Example
This folder contains an example of how to use the built-in ARE websocket. The demo generates a sine signal and broadcasts the signal data through a websocket (ws://localhost:8082/ws/astericsData). The data is visualized in a [webpage](http://asterics.github.io/AsTeRICS/demos.html#WebSocket) with a Javascript live chart. You can also send data to the model by pressing the "Send test message" button.
This folder contains an AsTeRICS based solution using the [APE (AsTeRICS Packaging Environment)](https://github.com/asterics/AsTeRICS/wiki/AsTeRICS-Packaging-Environment-(APE)) template folder structure.
# Prerequisites
You need at least
1. [Java Runtime Environment 8](http://www.oracle.com/technetwork/java/javase/downloads/jre8-downloads-2133155.html). **Some plugins only work with a 32-bit JRE.** You can have mixed installations of JREs/JDKs (32bit, 64bit). APE automatically prefers the 32-bit JDK/JRE on windows for the run targets. If you want to override this, set the property ```fx.platform.basedir``` in the file [APE.properties](APE.properties) to the path of your JDK/JRE.
If you want to create deployment files (.exe, .deb,...), you must have installed additional dependencies like a JDK.
2. [apache ant build framework (version >= 1.9.1)](http://ant.apache.org/bindownload.cgi) **or** an IDE for Java Developers, e.g. [Eclipse](http://www.eclipse.org/downloads/packages/eclipse-ide-java-developers/neon3) (already contains ant)
2. [AsTeRICS 3.0](https://github.com/asterics/AsTeRICS/releases/tag/v3.0) installed **or** a snapshot of [AsTeRICS](https://github.com/asterics/AsTeRICS) cloned to a parallel folder of the project.
# Demos / Examples
You can check the [demo](http://asterics.github.io/AsTeRICS/demos.html#WebSocket) and other [asterics solution example repositories](https://github.com/asterics?utf8=%E2%9C%93&q=topic%3Aexample&type=&language=).
# Run project
Enter
```ant run```
to build all the dependencies and start the ARE.
You can also start the ARE using the ARE start-scripts in the ```build/merged/bin/ARE``` folder.
# Release project
To create a native installer open a console and run
```ant deploy```
Please also check additional [dependencies](https://github.com/asterics/AsTeRICS/tree/master/bin/APE#dependencies) and [usage examples](https://github.com/asterics/AsTeRICS/tree/master/bin/APE#example-usages-of-the-build-infrastructure).
# Folder structure
Subsequently you can see the simplified folder structure of an APE-based project, which contains an ant build file (**```build.xml```**), a property-based configuration file (**```APE.properties```**), the **```custom/bin/ARE```** folder to store the solution-specific files (e.g. model files), a **```build```** folder and a **```package```** folder for native installer customization.
```
build
|- merged
|- deploy
custom
|- bin/ARE
|- data
|- images
|- LICENSE
|- models
|- .acs
|- ...
|-profile
|- web
|- webapps
|- startpage
|- start.html
|-
|- index.html
package
|- linux
|- windows
|- macosx
APE.properties
build.xml
```
# How to use the repository
Put all your custom files (model files, images, config files,...) to the [custom/bin/ARE](custom/bin/ARE) folder.
In case you have a web UI put the files (.html, images, .css, .js,...) to the document root [(custom/bin/ARE/web)](custom/bin/ARE/web) of the built-in webserver. The webserver also provides a [websocket](https://github.com/asterics/AsTeRICS/wiki/AsTeRICS-Websocket). Finally the ARE provides a [REST API](https://github.com/asterics/AsTeRICS/wiki/AsTeRICS-REST-API) that can be used within a web application.
Before the project can be run it must be [built](#build-project) (builds the AsTeRICS repository and copies/merges needed plugin jars and project files to the ```build/merged/bin/ARE`` folder). You can also directly [run](#run-project) the ARE with the project's solution.
# Recommended workflow
1. Save custom files (models, images, config files,...) to the custom/bin/ARE folder or subfolders (e.g. web/...) or modify them
2. Call ```ant APE-copy & ant run-quick```
3. This should automatically open [http://localhost:8081](http://localhost:8081) in your standard browser.
4. If you want to modify the running model, press 'F8' to open it in the WebACS, then modify and upload it. To save successful modifications permanently, save the model file to the ```custom/bin/ARE/models``` folder again.
5. Kill program and go to step 1
# Other ant targets
To see all supported targets, call
```ant -projecthelp```
# Changing AsTeRICS snapshot (ARE) used
The property ```ARE.baseURI``` defines the location of the ARE used for the execution of the project.
APE automatically searches for an ARE at the following locations:
1. ```dependencies/AsTeRICS/bin/ARE``` (if Asterics is added as submodule)
2. ```../AsTeRICS/bin/ARE``` (if it's an APE projectdir withouth FABI and FLipMouse folder structure)
3. ```../../AsTeRICS/bin/ARE``` (if it's an AT solution folder structure)
4. ```C:/Program Files (x86)/AsTeRICS/ARE/``` (if there is an Asterics installation on windows)
You can also set ARE.baseURI manually, either in the file ```APE.properties``` or within an ant call, e.g.
```ant -DARE.baseURI= run```
```ant -DARE.baseURI=D:/AsTeRICS/AsTeRICS/bin/ARE/ run```
# License
Dual license MIT or GPLv3 with CLASSPATH exception. Please read more in the [license section](https://github.com/asterics/AsTeRICS/wiki/Licensing) of the wiki.