Commit 35c761c0 by Raphael Deimel

add description of major changes between API versions

parent ebb5be9a
# What is the pneumaticbox-airserver?
# What is the pneumaticbox-airserver? #
This software is a server that provides an environment to configure/start/stop controllers,
schedule control signals and monitor signals remotely.
......@@ -20,7 +20,7 @@ The intended use pattern is to configure all required controllers in a setup pha
and only activate or deactivate controllers during control.
### Features
### Features ###
* Remotely configurable and reconfigurable control setup. No application-specific data are stored on the server side.
* A set of controller components dedicated to pneumatic control
......@@ -34,8 +34,32 @@ and only activate or deactivate controllers during control.
* Scheduling of signal trajectories, i.e. scheduling signal changes in the near future; This avoids network jitter and decouples non-RealTime clients from RT control
* Small codebase, making server execution very reliable.
# API Version Major Changes #
#Installation Instructions
##API Version 9 ##
* adds mass controller
* increase number of messages per second being parsed at most from 20 to 100
Backwards compatibility: API8 clients can use API9 server
## API Version 8 ##
* The EmergencySoftStop state is now exposed via a read-only client signal. I.e. clients can now monitor E-stop state
* The server advertises its version to the client upon connect, by sending a MsgAdvertiseVersion message. Clients can use this to check backwards/forward compatibility
* MsgReset now doesn't remove signal subscriptions bound to other connections. I.e. monitoring-only scripts do not stop working when reconfiguring/resetting the pneumaticbox
* Adds Bang-Bang controller for controlling a compressor via compressor pins
Backwards compatibility: none
## API Version 7 ##
* refactor configuration messages, replaces old monolithic messages with controller-specific ones
Backwards compatibility: none
#Installation Instructions#
##Compilation
For compiling, simply use:
......@@ -95,6 +119,7 @@ The airserver reports the raw adc values on startup. To calibrate the ADC, copy
If the file exists, the airserver will subtract these values from the ADC signal.
# Licence
This software is distributed under the BSD Licence. See LICENCE.txt for details.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment