Skip to content

Commit

Permalink
README corrections.
Browse files Browse the repository at this point in the history
  • Loading branch information
pid1 committed May 1, 2015
1 parent f2015d8 commit bc4c41f
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ Thermocontroller is an interactive server/client setup for environmental control

##Usage Instructions
Program Requirements
The thermostat/thermocontroller device code is designed to be run on a Raspberry Pi device. The code has been tested on a Raspberry Pi Model B and Model B+. The Pi4J library is used for interfacing between Java and the Raspberry Pi. To install the distributed executable for each thermostat in the network you must use the "Export" feature in Eclipse to package the JAR file. During the export process you must select the Main Class file to be *ThermostatDevice.java* in the *thermostat* package. You must also make sure that you have the Pi4J library linked to the project and you select package required libraries with executable in the export process. The executable building was only tested on Mac OSX 10.10.3. To execute on the Pi: you must be running the latest version of Raspian, have an internet connection, and have Java 8 installed. Use the terminal command java -jar EXECUTABLE_FILE_NAME.jar to run program.
The thermostat/thermocontroller device code is designed to be run on a Raspberry Pi device. The code has been tested on a Raspberry Pi Model B and Model B+. The Pi4J library is used for interfacing between Java and the Raspberry Pi. To install the distributed executable for each thermostat in the network you must use the "Export" feature in Eclipse to package the JAR file. During the export process you must select the Main Class file to be *ThermostatDevice.java* in the *thermostat* package. You must also make sure that you have the Pi4J library linked to the project and you select package required libraries with executable in the export process. The executable building was only tested on Mac OSX 10.10.3. To execute on the Pi, you must be running the latest version of Raspian, an local network connection as defined below, and have the proprietary Oracle Java 8 runtime installed. Your terminal command to launch the .jar will vary by Linux distribution installed, but on Raspbian will be java -jar EXECUTABLE_FILE_NAME.jar.

The server functionality runs in a JavaFX GUI. This requires the proprietary Oracle Java 8 runtime. It has been tested on Windows 7 SP2, OSX 10.10.3, and Arch GNU/Linux with Java 1.8.0_45.

The networking code currently hard-codes IP addresses of 192.168.1.102 for the server and 192.168.1.103 for the Raspberry Pi thermostat device. There is unimplemented code that will allow for automatic device discovery.
The networking code currently hard-codes IP addresses of 192.168.1.102 for the server and 192.168.1.103 for the Raspberry Pi thermostat device. There is unimplemented code that will allow for automatic device discovery in the future.

##License
Thermocontroller is licensed under the GPLv3. A full copy of the license is provided with this program under the name LICENSE.txt
Expand Down

0 comments on commit bc4c41f

Please sign in to comment.