Framework for Java and Groovy Agents
fjåge provides a lightweight and easy-to-learn framework for agent-oriented software development in Java and Groovy. Although most of the functionality of the framework can be used in pure-Java projects, the adoption of Groovy in the project simplifies development immensely. Typically, initialization scripts, shell interaction and command scripts are written in Groovy. Agents and support classes may be written in Java or Groovy.
- Lightweight and fast
- Easy to learn, and rapid agent development cycle
- Agent development in Java or Groovy
- Interactive Groovy shell and scripting
- Easy switching between realtime operation and discrete event simulation
- APIs for access from Java, Groovy, Python, C, Julia, and Javascript
- JSON-based protocol to interface with external applications
<dependency>
<groupId>com.github.org-arl</groupId>
<artifactId>fjage</artifactId>
<version>2.0.1</version>
</dependency>
fjåge follows Semantic Versioning. The current major version is 2.x.y.
The main changes in the version 2.0.0 compared to the previous 1.x series are:
- The
WebSocketConnectorclass was renamed toWebSocketHubConnectorto accurately reflect it being an aggregator of multiple WebSocket connections, mainly to be used for Shells. - A new
WebSocketConnectorclass was added to provide a direct WebSocket connection to a fjåge agent for use withfjage.jsGateways. Shellagent messagesPutFileReqandGetFileReqmessages had their parameter names changed to be more consistent with the rest of the API.WebServermethods for adding handlers have been cleaned-up and renamed. NowWebServer.addStaticadds a handler to serve static files,WebServer.addHandleradds a generic handler.
Since these changes are not backward compatible, the version number was incremented to 2.0.0.
The last stable release of the 1.x series is 1.14. The patch branch patch-1.14.x is maintained for bug fixes and minor improvements.
If you want to keep using fjåge 1.x, you can use the latest 1.14.x release.
With the update of WebSocketConnector to be a direct (non-aggregated) connection to a fjåge agent, the fjage.js library was also updated to support watching for specific topics as per the fjåge Gateway specification. This allows for a more efficient use of the WebSocket connection and reduces the amount of data sent over the network.
The 1.15.x releases 1.15.0, 1.15.1, and 1.15.2 have some of the breaking changes (specifically the changed parameter names) but didn't increment the major version number. This was a oversight and the 1.15.x releases are not backward compatible with the 1.14.x releases. The 1.15.x releases are not maintained anymore and should not be used.
Contributions are always welcome! Clone, develop and do a pull request!
Try to stick to the coding style already in use in the repository. Additionally, some guidelines:
Building:
gradleto build the jars including resources (webshell, fjage.js, etc.)gradle liteto build only the jarsgradle testto run all regression tests (automated through Github actions CI)gradle publishto upload jars to Maven staging (requires credentials)make htmlto build developer's documentation (automated through ReadTheDocs)gradle javadocto build the Java API documentationnpm run docsto build the Javascript API documentation
fjåge is licensed under the Simplified (3-clause) BSD license. See LICENSE.txt for more details.