albahrani / aquacontrol-server

A pi4j based aquarium management server. It uses the Pi4J PCA9685GpioProvider to generate PWM signals for light control. It is accessible over REST service interfaces over the integrated RESTExpress server.

aquacontrol-server

A pi4j based aquarium management server. It uses the Pi4J PCA9685GpioProvider to generate PWM signals for light control. It is accessible over REST service interfaces over the integrated RESTExpress server.

PROJECT INFORMATION

Project website: https://github.com/albahrani/aquacontrol-server
Project issues list: https://github.com/albahrani/aquacontrol-server/issues

No releases yet available from Maven Central.

Snapshot builds are available via

  <dependency>
    <groupId>com.github.albahrani.aquacontrol</groupId>
    <artifactId>aquacontrol-server</artifactId>
    <version>0.0.1-SNAPSHOT</version>
  </dependency>
  ...
  <repository>
    <id>sonatype-snapshots-repo</id>
    <url>https://oss.sonatype.org/content/repositories/snapshots</url>
    <releases><enabled>false</enabled></releases>
    <snapshots><enabled>true</enabled></snapshots>
  </repository>

LICENSE

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

USAGE

aquacontrol-server JAR

The AquaControl server shall be packaged in an runnable jar file which can be executed on a Raspberry Pi with an JRE8 or newer. For executing the software you need to provide two program arguments.

• -c <path_to_configuration> (Read-only)
• -p <path_to_light_plan> (Read-Write)

An example config file:

{
 "channels": [
   {"id":"coolwhite","name":"Cool White", "color" : "#ffffff", "pins": ["PWM 0","PWM 4"]},
   {"id":"red", "name":"Red", "color" : "#ff0000", "pins":["PWM 1","PWM 5"]},
   {"id":"blue", "name":"Blue", "color" : "#0000ff", "pins":["PWM 2","PWM 6"]},
   {"id":"warmwhite", "name":"Warm White", "color" : "#ffeeee", "pins":["PWM 3", "PWM 7"]}   
 ]
}

An example plan:

{
  "channels" : [ {
    "id" : "coolwhite",
    "timetable" : [ {
      "time" : [ 10, 0 ],
      "perc" : 100.0
    }, {
      "time" : [ 17, 0 ],
      "perc" : 0.0
    }, {
      "time" : [ 19, 0 ],
      "perc" : 100.0
    }, {
      "time" : [ 22, 0 ],
      "perc" : 0.0
    } ]    
  }, {
    "id" : "red",
    "timetable" : [ {
      "time" : [ 6, 0 ],
      "perc" : 100.0
    }, {
      "time" : [ 12, 0 ],
      "perc" : 0.0
    }, {
      "time" : [ 16, 0 ],
      "perc" : 100.0
    }, {
      "time" : [ 17, 0 ],
      "perc" : 0.0
    } ]    
  }]
}

REST Services

The server is accessible via RESTfull Webservices. All Webservices support CORS preflight requests. The following WebServices are currently available:

• PUT /shutdown Stops the aquacontrol-server software
• PUT /pause Pause the aquacontrol-server plan execution
• PUT /resume Resume a paused aquacontrol-server
• POST /channels/{channelId}/force Force a certain value for the light channel specified by its channelId. This channel will be excluded from plan execution and keep the forced (static) value.
• DELETE /channels/{channelId}/clear Clear the forced value of a light channel specified by its channelId. This channel will be included to plan execution and is updated with its current plan value.
• GET /status Provides a Status report about the current light channels and their values. Additionally the most important system parameters are included.
• GET /plan Returns the currently active light plan.
• POST /plan Uploads a new light plan and activates it.

There are several WebServices that are only available when really running on Raspberry Pi. See pi4j-rest-sysinfo for the services available. They are all registered under the baseUri /raspberry/systeminfo.