diff --git a/javadoc/Core.html b/javadoc/Core.html
new file mode 100644
index 0000000..fa631f4
--- /dev/null
+++ b/javadoc/Core.html
@@ -0,0 +1,268 @@
+
+
+
+
+
+Core
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+java.lang.Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Summary
+
+Constructors
+Constructor and Description
+
+
+Core
+
+
+
+
+
+
+
+Method Summary
+
+
+
+
+
+Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Detail
+
+
+
+
+
+Core
+public Core()
+
+
+
+
+
+
+
+
+Method Detail
+
+
+
+
+
+
+
+
+
Database
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+java.lang.Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Summary
+
+Constructors
+Constructor and Description
+
+
+Database
+
+
+
+
+
+
+
+Method Summary
+
+
+
+
+
+Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Detail
+
+
+
+
+
+Database
+public Database()
+
+
+
+
+
+
+
+
+Method Detail
+
+
+
+
+
+
+
+
+
Field
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+java.lang.Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Summary
+
+Constructors
+Constructor and Description
+
+
+Field
+
+
+
+
+
+
+
+Method Summary
+
+
+
+
+
+Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Detail
+
+
+
+
+
+Field
+public Field()
+
+
+
+
+
+
+
+
+Method Detail
+
+
+
+
+
+
+
+
+
Web
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+java.lang.Object
+
+
+
+
+
+
+
+public class Web
+extends java.lang.Object
+This class is used to test the web interface.
+ It creates a web server on localhost:8888 and sends data to it.
+ - Values are sent every 2 seconds
+ - A variation of the values is simulated (see the code)
+ - Some values are set to the same value as the remote values (see the code)
+
+
+
+
+
+
+
+
+
+
+
+Constructor Summary
+
+Constructors
+Constructor and Description
+
+
+Web
+
+
+
+
+
+
+
+Method Summary
+
+
+
+
+
+Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Detail
+
+
+
+
+
+
+
+
+
+
+Method Detail
+
+
+
+
+
+
+
+
+
All Classes
+All Classes
+
+
+
diff --git a/javadoc/allclasses-noframe.html b/javadoc/allclasses-noframe.html
new file mode 100644
index 0000000..86f1dbd
--- /dev/null
+++ b/javadoc/allclasses-noframe.html
@@ -0,0 +1,38 @@
+
+
+
+
+
+All Classes
+All Classes
+
+
+
diff --git a/javadoc/ch/hevs/isi/MinecraftController.html b/javadoc/ch/hevs/isi/MinecraftController.html
new file mode 100644
index 0000000..bea2cc4
--- /dev/null
+++ b/javadoc/ch/hevs/isi/MinecraftController.html
@@ -0,0 +1,323 @@
+
+
+
+
+
+MinecraftController
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+java.lang.Object
+
+
+ch.hevs.isi.MinecraftController
+
+
+
+
+
+
+
+
+
+
+
+
+Field Summary
+
+
+
+
+
+
+
+Constructor Summary
+
+
+
+
+
+
+
+Method Summary
+
+
+
+
+
+Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+
+
+
+
+
+
+
+
+
+
+
+
+Field Detail
+
+
+
+
+
+
+
+
+
+
+Constructor Detail
+
+
+
+
+
+
+
+
+
+
+
SmartControl
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+java.lang.Object
+
+
+ch.hevs.isi.SmartControl
+
+
+
+
+
+
+
+
+
+
+
+
+Field Summary
+
+
+
+
+
+
+
+Constructor Summary
+
+Constructors
+Constructor and Description
+
+
+SmartControl
+
+
+
+
+
+
+
+Method Summary
+
+
+
+
+
+Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+
+
+
+
+
+
+
+
+
+
+
+
+Field Detail
+
+
+
+
+
+
+
+
+
+
+Constructor Detail
+
+
+
+
+
+SmartControl
+public SmartControl()
+
+
+
+
+
+
+
+
+Method Detail
+
+
+
+
+
+run
+public boolean run()
+
+
+
+
+
+
+
BooleanDataPoint
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+java.lang.Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+Field Summary
+
+
+
+
+
+
+
+Constructor Summary
+
+Constructors
+Constructor and Description
+
+
+BooleanDataPoint Create a new DataPoint with a label and if is an Output or not
+
+
+
+
+
+
+
+
+Method Summary
+
+All Methods Instance Methods Concrete Methods
+Modifier and Type
+Method and Description
+
+
+booleangetValue Get the value of this DataPoint
+
+
+voidsetValue Set the value of this DataPoint and create it if it doesn't exist via the update method
+
+
+java.lang.StringtoString Convert this DataPoint to a string
+
+
+
+
+
+
+
+Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Detail
+
+
+
+
+
+BooleanDataPoint
+public BooleanDataPoint(java.lang.String label,
+ boolean isOutput)
+Create a new DataPoint with a label and if is an Output or not
+
+Parameters: label - the label of this DataPointisOutput - true if this is an Output, false if it's an Input
+
+
+
+
+
+
+
+
+
DataPoint
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+java.lang.Object
+
+
+ch.hevs.isi.core.DataPoint
+
+
+
+
+
+
+
+
+
+
+
+
+Field Summary
+
+Fields
+Modifier and Type
+Field and Description
+
+
+static java.util.Map<java.lang.String,DataPoint >dataPointMap
+
+
+
+
+
+
+
+Constructor Summary
+
+Constructors
+Modifier
+Constructor and Description
+
+
+protected DataPoint Constructor of DataPoint
+
+
+
+
+
+
+
+
+Method Summary
+
+
+
+
+
+Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+
+
+
+
+
+
+
+
+
+
+
+
+Field Detail
+
+
+
+
+
+
+
+
+
+
+Constructor Detail
+
+
+
+
+
+
+
+
+
+
+Method Detail
+
+
+
+
+
+update
+protected void update(boolean isNewValue)
+Update the value of this DataPoint and notify every connector
+ If this is a new value (doesn't exist), add it to the dataPointMap
+
+Parameters: isNewValue - true if this is a new value, false if it's an update
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
DataPointListener
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Field Summary
+
+
+
+
+
+
+
+Method Summary
+
+
+
+
+
+
+
+
+
+
+
+
+
+Field Detail
+
+
+
+
+
+
+
+
+
+
+
FloatDataPoint
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+java.lang.Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+Field Summary
+
+
+
+
+
+
+
+Constructor Summary
+
+Constructors
+Constructor and Description
+
+
+FloatDataPoint Create a new DataPoint with a label and if is an Output or not
+
+
+
+
+
+
+
+
+Method Summary
+
+All Methods Instance Methods Concrete Methods
+Modifier and Type
+Method and Description
+
+
+floatgetValue Get the value of this DataPoint
+
+
+voidsetValue Set the value of this DataPoint and create it if it doesn't exist via the update method
+
+
+java.lang.StringtoString Convert this DataPoint to a string
+
+
+
+
+
+
+
+Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Detail
+
+
+
+
+
+FloatDataPoint
+public FloatDataPoint(java.lang.String label,
+ boolean isOutput)
+Create a new DataPoint with a label and if is an Output or not
+
+Parameters: label - the label of this DataPointisOutput - true if this is an Output, false if it's an Input
+
+
+
+
+
+
+
+
+
ch.hevs.isi.core
+
+
Interfaces
+
+
Classes
+
+
ch.hevs.isi.core
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/javadoc/ch/hevs/isi/core/package-tree.html b/javadoc/ch/hevs/isi/core/package-tree.html
new file mode 100644
index 0000000..b726e9c
--- /dev/null
+++ b/javadoc/ch/hevs/isi/core/package-tree.html
@@ -0,0 +1,144 @@
+
+
+
+
+
+ch.hevs.isi.core Class Hierarchy
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
Class Hierarchy
+
+
Interface Hierarchy
+
+
DatabaseConnector
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+java.lang.Object
+
+
+ch.hevs.isi.db.DatabaseConnector
+
+
+
+
+
+
+
+
+
+
+
+
+Field Summary
+
+Fields
+Modifier and Type
+Field and Description
+
+
+static java.lang.Stringbucket
+
+static java.lang.Stringorg
+
+static java.lang.Stringurl
+
+
+
+
+
+
+
+
+Method Summary
+
+
+
+
+
+Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+
+
+
+
+
+
+
TimeManager
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+java.lang.Object
+
+
+ch.hevs.isi.db.TimeManager
+
+
+
+
+
+
+public class TimeManager
+extends java.lang.Object
+TimeManager Class
+
+ This class allows to calculate a timestamp taking into account the time index of Minecraft Electrical Age and its
+ time acceleration. (1 day = 10 minutes)
+ You also have to indicate a number of days to subtract from the current time which will determine the time t0 which
+ defines the starting time of the simulation.
+
+
+
+
+
+
+
+
+
+
+
+Constructor Summary
+
+Constructors
+Constructor and Description
+
+
+TimeManager Constructor of TimeManager class, where the start time of the game is calculated from today at midnight minus
+ the given number of days.
+
+
+
+
+
+
+
+
+Method Summary
+
+All Methods Static Methods Instance Methods Concrete Methods
+Modifier and Type
+Method and Description
+
+
+longgetNanosForDB Gives the actual timestamp according to the EA clock.
+
+
+booleanisLastDay Returns true
+
+
+static voidmain
+
+voidsetTimestamp This method takes the index of the Electrical-Age clock and generates the corresponding timestamp.
+
+
+voidsetTimestamp This method takes the index of the Electrical-Age clock and generates the corresponding timestamp.
+
+
+
+
+
+
+Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Detail
+
+
+
+
+
+TimeManager
+public TimeManager(int minusDays)
+Constructor of TimeManager class, where the start time of the game is calculated from today at midnight minus
+ the given number of days. Today at midnight, from local time.
+
+Parameters: minusDays - The number of days to subtract to the current day.
+
+
+
+
+
+
+
+
+
ch.hevs.isi.db
+ch.hevs.isi.db
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Class Summary
+Class
+Description
+
+
+
+DatabaseConnector
+
+
+TimeManager
+TimeManager Class
+
+ This class allows to calculate a timestamp taking into account the time index of Minecraft Electrical Age and its
+ time acceleration. (1 day = 10 minutes)
+ You also have to indicate a number of days to subtract from the current time which will determine the time t0 which
+ defines the starting time of the simulation.
+
+
+
+
+
+
+
ch.hevs.isi.db Class Hierarchy
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/javadoc/ch/hevs/isi/field/BooleanRegister.html b/javadoc/ch/hevs/isi/field/BooleanRegister.html
new file mode 100644
index 0000000..0c0bb7e
--- /dev/null
+++ b/javadoc/ch/hevs/isi/field/BooleanRegister.html
@@ -0,0 +1,325 @@
+
+
+
+
+
+BooleanRegister
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+java.lang.Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Summary
+
+Constructors
+Constructor and Description
+
+
+BooleanRegister public constructor of the booleanRegister
+
+
+
+
+
+
+
+
+Method Summary
+
+All Methods Instance Methods Concrete Methods
+Modifier and Type
+Method and Description
+
+
+voidread function to read a datapoint from the modbus register
+
+
+voidwrite DataPoint dp)function to write datapoint on the modbus register
+
+
+
+
+
+
+
+Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Detail
+
+
+
+
+
+BooleanRegister
+public BooleanRegister(java.lang.String label,
+ boolean isOutput,
+ int address)
+public constructor of the booleanRegister
+
+Parameters: label - label of the datapointisOutput - true if it is an output datapointaddress - modbus address of the datapoint
+
+
+
+
+
+
+
+
+
FieldConnector
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+Summary:
+Nested |
+Field |
+Constr |
+Method
+
+Detail:
+Field |
+Constr |
+Method
+
+
+
+
+
+java.lang.Object
+
+
+ch.hevs.isi.field.FieldConnector
+
+
+
+
+
+
+
+
+
+
+
+
+Field Summary
+
+
+
+
+
+
+
+Method Summary
+
+All Methods Static Methods Instance Methods Concrete Methods
+Modifier and Type
+Method and Description
+
+
+static voidcreateRegister read the csv-file of the ModbusMap
+
+
+static FieldConnector getMySelf static method to create a singleton pattern of the class
+ checks if an instance of the class is already made
+ if not, it creates an instance of the class FieldConnector
+
+
+voidinitialize this method initialize the fieldConnector
+ it connects the ModbusAccessor, reads the csv-file of the ModbusMap
+ and starts the periodical polling of the modbus registers
+
+
+voidonNewValue DataPoint dp)
+
+voidstartPeriodicalPolling method to start a periodical task
+ in our case it is the reading of the modbus registers
+
+
+
+
+
+
+Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Detail
+
+
+
+
+
+getMySelf
+public static FieldConnector getMySelf()
+static method to create a singleton pattern of the class
+ checks if an instance of the class is already made
+ if not, it creates an instance of the class FieldConnector
+
+Returns: instance of FieldConnector
+
+
+
+
+
+
+
+
+
+
+
+
+initialize
+public void initialize(java.lang.String host,
+ int port,
+ java.lang.String pathToFile)
+this method initialize the fieldConnector
+ it connects the ModbusAccessor, reads the csv-file of the ModbusMap
+ and starts the periodical polling of the modbus registers
+
+Parameters: host - ip address of the serverport - port of the serverpathToFile - path to the file of all modbus registers (C:/.../ModbusMap.csv)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Summary:
+Nested |
+Field |
+Constr |
+Method
+
+Detail:
+Field |
+Constr |
+Method
+
+
+
+ FloatRegister
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+java.lang.Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Summary
+
+Constructors
+Constructor and Description
+
+
+FloatRegister public constructor of the Float Register
+
+
+
+
+
+
+
+
+Method Summary
+
+All Methods Instance Methods Concrete Methods
+Modifier and Type
+Method and Description
+
+
+voidread function to read a datapoint from the modbus register
+
+
+voidwrite DataPoint dp)function to write datapoint on the modbus register
+
+
+
+
+
+
+
+Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Detail
+
+
+
+
+
+FloatRegister
+public FloatRegister(java.lang.String label,
+ boolean isOutPut,
+ int address,
+ int range,
+ int offset)
+public constructor of the Float Register
+
+Parameters: label - label of the datapointisOutPut - true if it is an output datapointaddress - modbus address of the datapointrange - range of the datapoint valueoffset - offset of the datapoint value
+
+
+
+
+
+
+
+
+
ModbusAccessor
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+Summary:
+Nested |
+Field |
+Constr |
+Method
+
+Detail:
+Field |
+Constr |
+Method
+
+
+
+
+
+java.lang.Object
+
+
+ch.hevs.isi.field.ModbusAccessor
+
+
+
+
+
+
+
+
+
+
+
+
+Method Summary
+
+All Methods Static Methods Instance Methods Concrete Methods
+Modifier and Type
+Method and Description
+
+
+voidconnect this method creates a ModbusFactory and a TCPMaster
+ it also initialize the Master
+
+
+static ModbusAccessor getMySelf static method to create a singleton pattern of the class
+ checks if an instance of the class is already made
+ if not, it creates an instance of the class ModbusAccessor
+
+
+booleanreadBoolean method to read a boolean value in the correct modbus register
+ get the coil status of the register.
+
+
+floatreadFloat method to read a boolean value in the correct modbus register
+ get the value from the holding register
+
+
+voidwriteBoolean method to write a boolean value in the correct modbus register
+
+
+voidwriteFloat method to write a float value in the correct modbus register
+
+
+
+
+
+
+Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+
+
+
+
+
+
+
+
+
+
+
+
+Method Detail
+
+
+
+
+
+getMySelf
+public static ModbusAccessor getMySelf()
+static method to create a singleton pattern of the class
+ checks if an instance of the class is already made
+ if not, it creates an instance of the class ModbusAccessor
+
+Returns: instance of ModbusAccessor
+
+
+
+
+
+
+
+
+connect
+public void connect(java.lang.String ipAddress,
+ int port)
+this method creates a ModbusFactory and a TCPMaster
+ it also initialize the Master
+
+Parameters: ipAddress - IP-address of the serverport - port of the server
+
+
+
+
+
+
+
+writeBoolean
+public void writeBoolean(int register,
+ boolean value)
+method to write a boolean value in the correct modbus register
+
+Parameters: register - address of the registervalue - the desired boolean value
+
+
+
+
+
+
+
+writeFloat
+public void writeFloat(int register,
+ float value)
+method to write a float value in the correct modbus register
+
+Parameters: register - address of the registervalue - the desired float value
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Summary:
+Nested |
+Field |
+Constr |
+Method
+
+Detail:
+Field |
+Constr |
+Method
+
+
+
+ ModbusRegister
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+java.lang.Object
+
+
+ch.hevs.isi.field.ModbusRegister
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Summary
+
+Constructors
+Constructor and Description
+
+
+ModbusRegister
+
+
+
+
+
+
+
+Method Summary
+
+
+
+
+
+Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Detail
+
+
+
+
+
+ModbusRegister
+public ModbusRegister()
+
+
+
+
+
+
+
+
+Method Detail
+
+
+
+
+
+
+
+
+
+
+
+
+
+updateMapOfRegisters
+public void updateMapOfRegisters(java.lang.String label,
+ int address)
+add an register to the map of the modbus addresses
+
+Parameters: label - label of the datapointaddress - modbus address of the datapoint
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
PollTask
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+java.lang.Object
+
+
+java.util.TimerTask
+
+
+ch.hevs.isi.field.PollTask
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Summary
+
+Constructors
+Constructor and Description
+
+
+PollTask
+
+
+
+
+
+
+
+Method Summary
+
+
+
+
+
+Methods inherited from class java.util.TimerTask
+cancel, scheduledExecutionTime
+
+
+
+
+Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Detail
+
+
+
+
+
+PollTask
+public PollTask()
+
+
+
+
+
+
+
+
+Method Detail
+
+
+
+
+
+run
+public void run()
+
+Specified by: run in interface java.lang.RunnableSpecified by: run in class java.util.TimerTask
+
+
+
+
+
+
+
ch.hevs.isi.field
+ch.hevs.isi.field
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/javadoc/ch/hevs/isi/field/package-tree.html b/javadoc/ch/hevs/isi/field/package-tree.html
new file mode 100644
index 0000000..2546e82
--- /dev/null
+++ b/javadoc/ch/hevs/isi/field/package-tree.html
@@ -0,0 +1,147 @@
+
+
+
+
+
+ch.hevs.isi.field Class Hierarchy
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/javadoc/ch/hevs/isi/package-frame.html b/javadoc/ch/hevs/isi/package-frame.html
new file mode 100644
index 0000000..3bbbfce
--- /dev/null
+++ b/javadoc/ch/hevs/isi/package-frame.html
@@ -0,0 +1,21 @@
+
+
+
+
+
+ch.hevs.isi
+ch.hevs.isi
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/javadoc/ch/hevs/isi/package-tree.html b/javadoc/ch/hevs/isi/package-tree.html
new file mode 100644
index 0000000..4aca857
--- /dev/null
+++ b/javadoc/ch/hevs/isi/package-tree.html
@@ -0,0 +1,136 @@
+
+
+
+
+
+ch.hevs.isi Class Hierarchy
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/javadoc/ch/hevs/isi/utils/Utility.html b/javadoc/ch/hevs/isi/utils/Utility.html
new file mode 100644
index 0000000..a92d7f3
--- /dev/null
+++ b/javadoc/ch/hevs/isi/utils/Utility.html
@@ -0,0 +1,826 @@
+
+
+
+
+
+Utility
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+Prev Class
+Next Class
+
+
+
+
+
+
+
+
+
+
+
+java.lang.Object
+
+
+ch.hevs.isi.utils.Utility
+
+
+
+
+
+
+
+
+
+
+
+
+Field Summary
+
+Fields
+Modifier and Type
+Field and Description
+
+
+static booleanDEBUG_MODE
+
+static java.util.Randomrnd Object to get some random values...
+
+
+static intTCP_BUFFER_SIZE Default size for the TCP input stream
+
+
+
+
+
+
+
+
+Constructor Summary
+
+Constructors
+Constructor and Description
+
+
+Utility
+
+
+
+
+
+
+
+Method Summary
+
+All Methods Static Methods Concrete Methods
+Modifier and Type
+Method and Description
+
+
+static java.lang.FloatbytesToFloat Returns a float value from array of bytes.
+
+
+static byte[]calculateCRC Calculates and returns the CRC using the data passed in parameters.
+
+
+static booleancheckCRC Checks the CRC and returns true if it is correct, otherwise false.
+
+
+static voidDEBUG
+
+static voidDEBUG
+
+static voidDEBUG
+
+static java.io.BufferedReaderfileParser Method to use to access a file in your resources folder...
+
+
+static java.lang.StringgetHexString Utility method to convert a byte array in a string made up of hex (0,.. 9, a,..f)
+
+
+static java.lang.StringgetHexString Utility method to convert a byte array in a string made up of hex (0,.. 9, a,..f)
+
+
+static java.lang.StringgetHexStringForDebug Utility method to convert a byte array in a string made up of hex (0,.. 9, a,..f) and
+ format the string with `0xCC` where CC is the string in HEX
+
+
+static java.lang.StringgetStringRndVal Retrieves a random value rounded to 2 decimal...
+
+
+static java.lang.Stringmd5sum Returns the md5 of any input...
+
+
+static voidpDebug
+
+static byte[]readBytes Reads the incoming data from an input stream as long as there is
+ something to read and saved the data in an array of bytes.
+
+
+static java.util.List<java.lang.String>readLine Reads lines of text from the given input stream.
+
+
+static byte[]readNBytes Reads from the given input stream an amount of bytes and retrieves these data as
+ an array of bytes.
+
+
+static voidthreadWait To be used to make a thread waiting for a certain amount of time
+
+
+static intunsignedByteToSignedInt Converts an unsigned byte to a signed integer.
+
+
+static voidwaitSomeTime To wait some times ...
+
+
+static voidwriteLine Send the data contained in the given array of bytes through the output
+ stream.
+
+
+
+
+
+
+Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Detail
+
+
+
+
+
+Utility
+public Utility()
+
+
+
+
+
+
+
+
+Method Detail
+
+
+
+
+
+calculateCRC
+public static byte[] calculateCRC(byte[] data,
+ int offset,
+ int len)
+Calculates and returns the CRC using the data passed in parameters.
+
+Parameters: data - a byte array containing the data to sendoffset - the offsetlen - the data lengthReturns: byte[] the CRC
+
+
+
+
+
+
+
+
+checkCRC
+public static boolean checkCRC(byte[] data,
+ int offset,
+ int len,
+ byte[] crc)
+Checks the CRC and returns true if it is correct, otherwise false.
+
+Parameters: data - a byte array containing the data to sendoffset - the offsetlen - the data lengthcrc - a byte array containing the CRC to checkReturns: boolean true if the CRC is correct, otherwise false
+
+
+
+
+
+
+
+
+bytesToFloat
+public static java.lang.Float bytesToFloat(byte[] bytes,
+ int offset,
+ int size)
+Returns a float value from array of bytes. This byte's array can only be 2 or 4 bytes long.
+
+Parameters: bytes - The array of bytes to convert.offset - The position where the method has to start to get the bytes from.size - The amount of bytes to convert.Returns: A Float value or null if the process failed.
+
+
+
+
+
+
+
+
+
+
+
+
+getHexString
+public static java.lang.String getHexString(byte[] b)
+Utility method to convert a byte array in a string made up of hex (0,.. 9, a,..f)
+
+Parameters: b - The array of bytes to be convert in HEX characters.Returns: A string representing the given array of byte in HEX values.
+
+
+
+
+
+
+
+
+getHexString
+public static java.lang.String getHexString(byte[] b,
+ int offset,
+ int length)
+Utility method to convert a byte array in a string made up of hex (0,.. 9, a,..f)
+
+Parameters: b - The byte array to convert in HEX stringoffset - The index where we start to convert from.length - The amount of bytes to convert in HEX stringReturns: A String representing the HEX values of the selected bytes of the array.
+
+
+
+
+
+
+
+
+getHexStringForDebug
+public static java.lang.String getHexStringForDebug(byte[] b,
+ int offset,
+ int length)
+Utility method to convert a byte array in a string made up of hex (0,.. 9, a,..f) and
+ format the string with `0xCC` where CC is the string in HEX
+
+Parameters: b - The byte array to convert in HEX stringoffset - The index where we start to convert from.length - The amount of bytes to convert in HEX stringReturns: A String representing the HEX values of the selected bytes of the array.
+
+
+
+
+
+
+
+
+threadWait
+public static void threadWait(java.lang.Thread thread,
+ long millis)
+To be used to make a thread waiting for a certain amount of time
+
+Parameters: thread - The thread to be stoppedmillis - The amount of time in [ms] to stop the thread.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+readBytes
+public static byte[] readBytes(java.io.InputStream in)
+ throws java.io.IOException
+Reads the incoming data from an input stream as long as there is
+ something to read and saved the data in an array of bytes.
+
+ The method is blocking !
+ This method blocks until input data is available, end of file is detected,
+ or an exception is thrown.
+
+ If the length of of read data is zero, then no bytes are read and an empty
+ array of bytes is returned; otherwise, there is an attempt to read at least
+ one byte. If no byte is available because the stream is at the end of the
+ file, the value -1 is returned; otherwise, at least one byte is read and
+ returned as an array of bytes.
+
+Parameters: in - The input Stream where to read the data coming from.Returns: The read data as an array of bytes. Or null if the
+ has been closed by the peer while waiting for incoming data.
+Throws: java.io.IOException - If the first byte cannot be read for any reason other
+ than the end of the file, if the input stream has been
+ closed, or if some other I/O error occurs.
+
+
+
+
+
+
+
+readNBytes
+public static byte[] readNBytes(java.io.InputStream in,
+ int len)
+ throws java.io.IOException
+Reads from the given input stream an amount of bytes and retrieves these data as
+ an array of bytes. This method is
+
+ The method is blocking !
+
+Parameters: in - The input Stream where to read the data coming from.len - The number of bytes to be read from the input stream.Returns: The read data as an array of bytes.
+Throws: java.io.IOException - If the first byte cannot be read for any reason other
+ than the end of the file, if the input stream has been
+ closed, or if some other I/O error occurs.
+
+
+
+
+
+
+
+readLine
+public static java.util.List<java.lang.String> readLine(java.io.InputStream in)
+ throws java.io.IOException
+Reads lines of text from the given input stream. A line is considered to be terminated by any one of a
+ line feed ('\n'), a carriage return ('\r'), or a carriage return followed immediately by a line feed.
+
+Parameters: in - The Input Stream to read from.Returns: A list of String, without any line-termination characters, corresponding to each line read from the
+ input stream, or an empty list if the end of the stream has been reached.
+Throws: java.io.IOException - If an I/O error occurs
+
+
+
+
+
+
+
+writeLine
+public static void writeLine(java.io.OutputStream out,
+ byte[] toSend)
+ throws java.io.IOException
+Send the data contained in the given array of bytes through the output
+ stream. It raises an IOException if something goes wrong.
+ The method returns the amount of bytes sent.
+
+Parameters: out - The Output Stream to send the data to.toSend - The data to sendThrows: java.io.IOException - If an I/O error occurs
+
+
+
+
+
+
+
+fileParser
+public static java.io.BufferedReader fileParser(java.lang.String pathName,
+ java.lang.String fileName)
+Method to use to access a file in your resources folder...
+
+Parameters: pathName - folder's name (if exists) from `resources`fileName - Name of the file to accessReturns: A BufferedReader related to the file you want to work with, or null if the file could not be reached.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+DEBUG
+public static void DEBUG(java.lang.String packageName,
+ java.lang.String className,
+ java.lang.String method,
+ java.lang.String msg)
+
+
+
+
+
+
+
+
+
+
+
+
+Prev Class
+Next Class
+
+
+
+
+
+
+
+
+
+ ch.hevs.isi.utils
+ch.hevs.isi.utils
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Class Summary
+Class
+Description
+
+
+
+Utility
+This class contains some useful Java methods to manipulate Modbus data.
+
+
+
+
+
+
+
ch.hevs.isi.utils Class Hierarchy
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/javadoc/ch/hevs/isi/web/WebConnector.html b/javadoc/ch/hevs/isi/web/WebConnector.html
new file mode 100644
index 0000000..1018364
--- /dev/null
+++ b/javadoc/ch/hevs/isi/web/WebConnector.html
@@ -0,0 +1,350 @@
+
+
+
+
+
+WebConnector
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+Prev Class
+Next Class
+
+
+
+
+
+
+
+
+
+
+
+java.lang.Object
+
+
+ch.hevs.isi.web.WebConnector
+
+
+
+
+
+
+
+
+
+
+
+
+Field Summary
+
+Fields
+Modifier and Type
+Field and Description
+
+
+org.java_websocket.server.WebSocketServerwss
+
+
+
+
+
+
+
+
+Method Summary
+
+All Methods Static Methods Instance Methods Concrete Methods
+Modifier and Type
+Method and Description
+
+
+static WebConnector getMySelf Get the singleton instance
+ create it if it does not exist
+
+
+voidinitialize Initialize webConnector by initializing the websocket server
+ - define all the callbacks for the websocket server (onOpen, onClose, onMessage, onError, onStart)
+ - start the websocket server
+ - wait for the first connection
+
+
+voidonNewValue DataPoint dp)Callback for the update of a dataPoint
+
+
+
+
+
+
+Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+
+
+
+
+
+
+
+
+
+
+
+
+
+Field Detail
+
+
+
+
+
+
+
+
+
+
+Method Detail
+
+
+
+
+
+
+
+
+
+initialize
+public void initialize(java.lang.String host,
+ int port)
+Initialize webConnector by initializing the websocket server
+ - define all the callbacks for the websocket server (onOpen, onClose, onMessage, onError, onStart)
+ - start the websocket server
+ - wait for the first connection
+
+Parameters: host - url of the host (localhost)port - port for the websocket server (8888)
+
+
+
+
+
+
+
+
+
+
+
+
+Prev Class
+Next Class
+
+
+
+
+
+
+
+
+
+ ch.hevs.isi.web
+ch.hevs.isi.web
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Class Summary
+Class
+Description
+
+
+
+WebConnector
+
+
+
+
+
+
ch.hevs.isi.web Class Hierarchy
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/javadoc/constant-values.html b/javadoc/constant-values.html
new file mode 100644
index 0000000..ffb9f2e
--- /dev/null
+++ b/javadoc/constant-values.html
@@ -0,0 +1,179 @@
+
+
+
+
+
+Constant Field Values
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
ch.hevs.*
+
+
+
+
+ch.hevs.isi.utils.Utility
+Modifier and Type
+Constant Field
+Value
+
+
+
+
+
+ public static final booleanDEBUG_MODE false
+
+
+
+ public static final intTCP_BUFFER_SIZE 4096
+
+
+
+
+
Deprecated List
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/javadoc/help-doc.html b/javadoc/help-doc.html
new file mode 100644
index 0000000..485f15a
--- /dev/null
+++ b/javadoc/help-doc.html
@@ -0,0 +1,223 @@
+
+
+
+
+
+API Help
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+Overview
+The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.
+
+
+Package
+Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:
+
+Interfaces (italic)
+Classes
+Enums
+Exceptions
+Errors
+Annotation Types
+
+
+
+Class/Interface
+Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
+
+Class inheritance diagram
+Direct Subclasses
+All Known Subinterfaces
+All Known Implementing Classes
+Class/interface declaration
+Class/interface description
+
+
+Nested Class Summary
+Field Summary
+Constructor Summary
+Method Summary
+
+
+Field Detail
+Constructor Detail
+Method Detail
+
+Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+
+
+Annotation Type
+Each annotation type has its own separate page with the following sections:
+
+Annotation Type declaration
+Annotation Type description
+Required Element Summary
+Optional Element Summary
+Element Detail
+
+
+
+Enum
+Each enum has its own separate page with the following sections:
+
+Enum declaration
+Enum description
+Enum Constant Summary
+Enum Constant Detail
+
+
+
+Tree (Class Hierarchy)
+There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
+
+When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
+When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
+
+
+
+Deprecated API
+The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+
+
+Index
+The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
+
+
+Prev/Next
+These links take you to the next or previous class, interface, package, or related page.
+
+
+Frames/No Frames
+These links show and hide the HTML frames. All pages are available with or without frames.
+
+
+All Classes
+The All Classes link shows all classes and interfaces except non-static nested types.
+
+
+Serialized Form
+Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.
+
+
+Constant Field Values
+The Constant Field Values page lists the static final fields and their values.
+
+
+
This help file applies to API documentation generated using the standard doclet. B-Index
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+B C D E F G I L M O P R S T U W
+
+
+
B
+
+BooleanDataPoint ch.hevs.isi.core
+BooleanDataPoint(String, boolean) BooleanDataPoint
+Create a new DataPoint with a label and if is an Output or not
+
+BooleanRegister ch.hevs.isi.field
+BooleanRegister(String, boolean, int) BooleanRegister
+public constructor of the booleanRegister
+
+bucket DatabaseConnector
+bytesToFloat(byte[], int, int) Utility
+Returns a float value from array of bytes.
+
+
+
B C D E F G I L M O P R S T U W O-Index
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+B C D E F G I L M O P R S T U W
+
+
+
O
+
+onNewValue(DataPoint) DataPointListener
+onNewValue(DataPoint) DatabaseConnector
+Push the data point to the database
+
+onNewValue(DataPoint) FieldConnector
+onNewValue(DataPoint) WebConnector
+Callback for the update of a dataPoint
+
+org DatabaseConnector
+
+
B C D E F G I L M O P R S T U W P-Index
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+B C D E F G I L M O P R S T U W
+
+
+
P
+
+pDebug(String) Utility
+poll() ModbusRegister
+read periodically each modbus register
+
+PollTask ch.hevs.isi.field
+PollTask() PollTask
+
+
B C D E F G I L M O P R S T U W R-Index
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+B C D E F G I L M O P R S T U W
+
+
+
R
+
+read() BooleanRegister
+read() FloatRegister
+read() ModbusRegister
+function to read a datapoint from the modbus register
+
+readBoolean(int) ModbusAccessor
+method to read a boolean value in the correct modbus register
+ get the coil status of the register.
+
+readBytes(InputStream) Utility
+Reads the incoming data from an input stream as long as there is
+ something to read and saved the data in an array of bytes.
+
+readFloat(int) ModbusAccessor
+method to read a boolean value in the correct modbus register
+ get the value from the holding register
+
+readLine(InputStream) Utility
+Reads lines of text from the given input stream.
+
+readNBytes(InputStream, int) Utility
+Reads from the given input stream an amount of bytes and retrieves these data as
+ an array of bytes.
+
+rnd Utility
+Object to get some random values...
+
+run() PollTask
+run() SmartControl
+
+
B C D E F G I L M O P R S T U W S-Index
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+B C D E F G I L M O P R S T U W
+
+
+
S
+
+setTimestamp(String) TimeManager
+This method takes the index of the Electrical-Age clock and generates the corresponding timestamp.
+
+setTimestamp(float) TimeManager
+This method takes the index of the Electrical-Age clock and generates the corresponding timestamp.
+
+setValue(boolean) BooleanDataPoint
+Set the value of this DataPoint and create it if it doesn't exist via the update method
+
+setValue(float) FloatDataPoint
+Set the value of this DataPoint and create it if it doesn't exist via the update method
+
+SmartControl ch.hevs.isi
+SmartControl() SmartControl
+startPeriodicalPolling() FieldConnector
+method to start a periodical task
+ in our case it is the reading of the modbus registers
+
+subscribeUpdate(DataPointListener) DataPointListener
+Subscribe to the update of the DataPoint
+
+
+
B C D E F G I L M O P R S T U W T-Index
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+B C D E F G I L M O P R S T U W
+
+
+
T
+
+TCP_BUFFER_SIZE Utility
+Default size for the TCP input stream
+
+threadWait(Thread, long) Utility
+To be used to make a thread waiting for a certain amount of time
+
+TIME_BETWEEN_UPDATES SmartControl
+TimeManager ch.hevs.isi.db
+TimeManager Class
+
+ This class allows to calculate a timestamp taking into account the time index of Minecraft Electrical Age and its
+ time acceleration. (1 day = 10 minutes)
+ You also have to indicate a number of days to subtract from the current time which will determine the time t0 which
+ defines the starting time of the simulation.
+
+TimeManager(int) TimeManager
+Constructor of TimeManager class, where the start time of the game is calculated from today at midnight minus
+ the given number of days.
+
+toString() BooleanDataPoint
+Convert this DataPoint to a string
+
+toString() FloatDataPoint
+Convert this DataPoint to a string
+
+
+
B C D E F G I L M O P R S T U W U-Index
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+B C D E F G I L M O P R S T U W
+
+
+
U
+
+unsignedByteToSignedInt(byte) Utility
+Converts an unsigned byte to a signed integer.
+
+update(boolean) DataPoint
+Update the value of this DataPoint and notify every connector
+ If this is a new value (doesn't exist), add it to the dataPointMap
+
+updateMapOfRegisters(String, int) ModbusRegister
+add an register to the map of the modbus addresses
+
+url DatabaseConnector
+usage() MinecraftController
+Utility ch.hevs.isi.utils
+This class contains some useful Java methods to manipulate Modbus data.
+
+Utility() Utility
+
+
B C D E F G I L M O P R S T U W W-Index
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+B C D E F G I L M O P R S T U W
+
+
+
W
+
+waitSomeTime(int) Utility
+To wait some times ...
+
+Web <Unnamed>
+This class is used to test the web interface.
+
+Web() Web
+WebConnector ch.hevs.isi.web
+write(DataPoint) BooleanRegister
+write(DataPoint) FloatRegister
+write(DataPoint) ModbusRegister
+function to write datapoint on the modbus register
+
+writeBoolean(int, boolean) ModbusAccessor
+method to write a boolean value in the correct modbus register
+
+writeFloat(int, float) ModbusAccessor
+method to write a float value in the correct modbus register
+
+writeLine(OutputStream, byte[]) Utility
+Send the data contained in the given array of bytes through the output
+ stream.
+
+wss WebConnector
+
+
B C D E F G I L M O P R S T U W C-Index
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+B C D E F G I L M O P R S T U W
+
+
+
C
+
+calculateCRC(byte[], int, int) Utility
+Calculates and returns the CRC using the data passed in parameters.
+
+ch.hevs.isi - package ch.hevs.isi
+ch.hevs.isi.core - package ch.hevs.isi.core
+ch.hevs.isi.db - package ch.hevs.isi.db
+ch.hevs.isi.field - package ch.hevs.isi.field
+ch.hevs.isi.utils - package ch.hevs.isi.utils
+ch.hevs.isi.web - package ch.hevs.isi.web
+checkCRC(byte[], int, int, byte[]) Utility
+Checks the CRC and returns true if it is correct, otherwise false.
+
+connect(String, int) ModbusAccessor
+this method creates a ModbusFactory and a TCPMaster
+ it also initialize the Master
+
+Core <Unnamed>
+Core() Core
+createRegister(String) FieldConnector
+read the csv-file of the ModbusMap
+
+
+
B C D E F G I L M O P R S T U W D-Index
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+B C D E F G I L M O P R S T U W
+
+
+
D
+
+Database <Unnamed>
+Class to test the database connector
+
+Database() Database
+DatabaseConnector ch.hevs.isi.db
+DataPoint ch.hevs.isi.core
+DataPoint(String, boolean) DataPoint
+Constructor of DataPoint
+
+DataPointListener ch.hevs.isi.core
+dataPointMap DataPoint
+DEBUG(String, String, String) Utility
+DEBUG(Object, String, String) Utility
+DEBUG(String, String, String, String) Utility
+DEBUG_MODE Utility
+
+
B C D E F G I L M O P R S T U W E-Index
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+B C D E F G I L M O P R S T U W
+
+
+
E
+
+ERASE_PREVIOUS_DATA_INB_DB MinecraftController
+
+
B C D E F G I L M O P R S T U W F-Index
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+B C D E F G I L M O P R S T U W
+
+
+
F
+
+Field <Unnamed>
+Field() Field
+FieldConnector ch.hevs.isi.field
+fileParser(String, String) Utility
+Method to use to access a file in your resources folder...
+
+FloatDataPoint ch.hevs.isi.core
+FloatDataPoint(String, boolean) FloatDataPoint
+Create a new DataPoint with a label and if is an Output or not
+
+FloatRegister ch.hevs.isi.field
+FloatRegister(String, boolean, int, int, int) FloatRegister
+public constructor of the Float Register
+
+
+
B C D E F G I L M O P R S T U W G-Index
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+B C D E F G I L M O P R S T U W
+
+
+
G
+
+getAddress() ModbusRegister
+get the address of the modbus register
+
+getDataPointOnListFromLabel(String) DataPoint
+Get the DataPoint from the label
+
+getHexString(byte[]) Utility
+Utility method to convert a byte array in a string made up of hex (0,.. 9, a,..f)
+
+getHexString(byte[], int, int) Utility
+Utility method to convert a byte array in a string made up of hex (0,.. 9, a,..f)
+
+getHexStringForDebug(byte[], int, int) Utility
+Utility method to convert a byte array in a string made up of hex (0,.. 9, a,..f) and
+ format the string with `0xCC` where CC is the string in HEX
+
+getLabel() DataPoint
+Just get the label of this DataPoint
+
+getMySelf() DatabaseConnector
+Get the instance of the database connector
+
+getMySelf() FieldConnector
+static method to create a singleton pattern of the class
+ checks if an instance of the class is already made
+ if not, it creates an instance of the class FieldConnector
+
+getMySelf() ModbusAccessor
+static method to create a singleton pattern of the class
+ checks if an instance of the class is already made
+ if not, it creates an instance of the class ModbusAccessor
+
+getMySelf() WebConnector
+Get the singleton instance
+ create it if it does not exist
+
+getNanosForDB() TimeManager
+Gives the actual timestamp according to the EA clock.
+
+getRegisterFromDatapoint(DataPoint) ModbusRegister
+get the modbus register from the desired datapoint
+
+getStringRndVal(int) Utility
+Retrieves a random value rounded to 2 decimal...
+
+getValue() BooleanDataPoint
+Get the value of this DataPoint
+
+getValue() FloatDataPoint
+Get the value of this DataPoint
+
+
+
B C D E F G I L M O P R S T U W I-Index
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+B C D E F G I L M O P R S T U W
+
+
+
I
+
+initialize(String) DatabaseConnector
+Initialize the database connector
+
+initialize(String, int, String) FieldConnector
+this method initialize the fieldConnector
+ it connects the ModbusAccessor, reads the csv-file of the ModbusMap
+ and starts the periodical polling of the modbus registers
+
+initialize(String, int) WebConnector
+Initialize webConnector by initializing the websocket server
+ - define all the callbacks for the websocket server (onOpen, onClose, onMessage, onError, onStart)
+ - start the websocket server
+ - wait for the first connection
+
+isLastDay() TimeManager
+Returns true
+
+isOutput() DataPoint
+
+
B C D E F G I L M O P R S T U W L-Index
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+B C D E F G I L M O P R S T U W
+
+
+
L
+
+listeners DataPointListener
+
+
B C D E F G I L M O P R S T U W M-Index
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+B C D E F G I L M O P R S T U W
+
+
+
M
+
+main(String[]) TimeManager
+main(String[]) MinecraftController
+main(String[]) Core
+main(String[]) Database
+main(String[]) Field
+main(String[]) Web
+md5sum(String) Utility
+Returns the md5 of any input...
+
+MinecraftController ch.hevs.isi
+MinecraftController() MinecraftController
+ModbusAccessor ch.hevs.isi.field
+ModbusRegister ch.hevs.isi.field
+ModbusRegister() ModbusRegister
+
+
B C D E F G I L M O P R S T U W Generated Documentation (Untitled)
+
+
+
+
+
+<![CDATA[
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<h2>Frame Alert</h2>
+<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="overview-summary.html">Non-frame version</a>.</p>
+]]>
+
+
diff --git a/javadoc/overview-frame.html b/javadoc/overview-frame.html
new file mode 100644
index 0000000..60fa132
--- /dev/null
+++ b/javadoc/overview-frame.html
@@ -0,0 +1,27 @@
+
+
+
+
+
+Overview List
+
+
+
diff --git a/javadoc/overview-summary.html b/javadoc/overview-summary.html
new file mode 100644
index 0000000..40ca6a7
--- /dev/null
+++ b/javadoc/overview-summary.html
@@ -0,0 +1,153 @@
+
+
+
+
+
+Overview
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/javadoc/overview-tree.html b/javadoc/overview-tree.html
new file mode 100644
index 0000000..5fb9984
--- /dev/null
+++ b/javadoc/overview-tree.html
@@ -0,0 +1,172 @@
+
+
+
+
+
+Class Hierarchy
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
Class Hierarchy
+
+
Interface Hierarchy
+
+
<Unnamed>
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Class Summary
+Class
+Description
+
+
+
+Core
+
+
+Database
+Class to test the database connector
+
+
+
+Field
+
+
+Web
+This class is used to test the web interface.
+
+
+
+
+
+
+
Class Hierarchy
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/javadoc/script.js b/javadoc/script.js
new file mode 100644
index 0000000..b346356
--- /dev/null
+++ b/javadoc/script.js
@@ -0,0 +1,30 @@
+function show(type)
+{
+ count = 0;
+ for (var key in methods) {
+ var row = document.getElementById(key);
+ if ((methods[key] & type) != 0) {
+ row.style.display = '';
+ row.className = (count++ % 2) ? rowColor : altColor;
+ }
+ else
+ row.style.display = 'none';
+ }
+ updateTabs(type);
+}
+
+function updateTabs(type)
+{
+ for (var value in tabs) {
+ var sNode = document.getElementById(tabs[value][0]);
+ var spanNode = sNode.firstChild;
+ if (value == type) {
+ sNode.className = activeTableTab;
+ spanNode.innerHTML = tabs[value][1];
+ }
+ else {
+ sNode.className = tableTab;
+ spanNode.innerHTML = "" + tabs[value][1] + " ";
+ }
+ }
+}
diff --git a/javadoc/stylesheet.css b/javadoc/stylesheet.css
new file mode 100644
index 0000000..98055b2
--- /dev/null
+++ b/javadoc/stylesheet.css
@@ -0,0 +1,574 @@
+/* Javadoc style sheet */
+/*
+Overall document style
+*/
+
+@import url('resources/fonts/dejavu.css');
+
+body {
+ background-color:#ffffff;
+ color:#353833;
+ font-family:'DejaVu Sans', Arial, Helvetica, sans-serif;
+ font-size:14px;
+ margin:0;
+}
+a:link, a:visited {
+ text-decoration:none;
+ color:#4A6782;
+}
+a:hover, a:focus {
+ text-decoration:none;
+ color:#bb7a2a;
+}
+a:active {
+ text-decoration:none;
+ color:#4A6782;
+}
+a[name] {
+ color:#353833;
+}
+a[name]:hover {
+ text-decoration:none;
+ color:#353833;
+}
+pre {
+ font-family:'DejaVu Sans Mono', monospace;
+ font-size:14px;
+}
+h1 {
+ font-size:20px;
+}
+h2 {
+ font-size:18px;
+}
+h3 {
+ font-size:16px;
+ font-style:italic;
+}
+h4 {
+ font-size:13px;
+}
+h5 {
+ font-size:12px;
+}
+h6 {
+ font-size:11px;
+}
+ul {
+ list-style-type:disc;
+}
+code, tt {
+ font-family:'DejaVu Sans Mono', monospace;
+ font-size:14px;
+ padding-top:4px;
+ margin-top:8px;
+ line-height:1.4em;
+}
+dt code {
+ font-family:'DejaVu Sans Mono', monospace;
+ font-size:14px;
+ padding-top:4px;
+}
+table tr td dt code {
+ font-family:'DejaVu Sans Mono', monospace;
+ font-size:14px;
+ vertical-align:top;
+ padding-top:4px;
+}
+sup {
+ font-size:8px;
+}
+/*
+Document title and Copyright styles
+*/
+.clear {
+ clear:both;
+ height:0px;
+ overflow:hidden;
+}
+.aboutLanguage {
+ float:right;
+ padding:0px 21px;
+ font-size:11px;
+ z-index:200;
+ margin-top:-9px;
+}
+.legalCopy {
+ margin-left:.5em;
+}
+.bar a, .bar a:link, .bar a:visited, .bar a:active {
+ color:#FFFFFF;
+ text-decoration:none;
+}
+.bar a:hover, .bar a:focus {
+ color:#bb7a2a;
+}
+.tab {
+ background-color:#0066FF;
+ color:#ffffff;
+ padding:8px;
+ width:5em;
+ font-weight:bold;
+}
+/*
+Navigation bar styles
+*/
+.bar {
+ background-color:#4D7A97;
+ color:#FFFFFF;
+ padding:.8em .5em .4em .8em;
+ height:auto;/*height:1.8em;*/
+ font-size:11px;
+ margin:0;
+}
+.topNav {
+ background-color:#4D7A97;
+ color:#FFFFFF;
+ float:left;
+ padding:0;
+ width:100%;
+ clear:right;
+ height:2.8em;
+ padding-top:10px;
+ overflow:hidden;
+ font-size:12px;
+}
+.bottomNav {
+ margin-top:10px;
+ background-color:#4D7A97;
+ color:#FFFFFF;
+ float:left;
+ padding:0;
+ width:100%;
+ clear:right;
+ height:2.8em;
+ padding-top:10px;
+ overflow:hidden;
+ font-size:12px;
+}
+.subNav {
+ background-color:#dee3e9;
+ float:left;
+ width:100%;
+ overflow:hidden;
+ font-size:12px;
+}
+.subNav div {
+ clear:left;
+ float:left;
+ padding:0 0 5px 6px;
+ text-transform:uppercase;
+}
+ul.navList, ul.subNavList {
+ float:left;
+ margin:0 25px 0 0;
+ padding:0;
+}
+ul.navList li{
+ list-style:none;
+ float:left;
+ padding: 5px 6px;
+ text-transform:uppercase;
+}
+ul.subNavList li{
+ list-style:none;
+ float:left;
+}
+.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited {
+ color:#FFFFFF;
+ text-decoration:none;
+ text-transform:uppercase;
+}
+.topNav a:hover, .bottomNav a:hover {
+ text-decoration:none;
+ color:#bb7a2a;
+ text-transform:uppercase;
+}
+.navBarCell1Rev {
+ background-color:#F8981D;
+ color:#253441;
+ margin: auto 5px;
+}
+.skipNav {
+ position:absolute;
+ top:auto;
+ left:-9999px;
+ overflow:hidden;
+}
+/*
+Page header and footer styles
+*/
+.header, .footer {
+ clear:both;
+ margin:0 20px;
+ padding:5px 0 0 0;
+}
+.indexHeader {
+ margin:10px;
+ position:relative;
+}
+.indexHeader span{
+ margin-right:15px;
+}
+.indexHeader h1 {
+ font-size:13px;
+}
+.title {
+ color:#2c4557;
+ margin:10px 0;
+}
+.subTitle {
+ margin:5px 0 0 0;
+}
+.header ul {
+ margin:0 0 15px 0;
+ padding:0;
+}
+.footer ul {
+ margin:20px 0 5px 0;
+}
+.header ul li, .footer ul li {
+ list-style:none;
+ font-size:13px;
+}
+/*
+Heading styles
+*/
+div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 {
+ background-color:#dee3e9;
+ border:1px solid #d0d9e0;
+ margin:0 0 6px -8px;
+ padding:7px 5px;
+}
+ul.blockList ul.blockList ul.blockList li.blockList h3 {
+ background-color:#dee3e9;
+ border:1px solid #d0d9e0;
+ margin:0 0 6px -8px;
+ padding:7px 5px;
+}
+ul.blockList ul.blockList li.blockList h3 {
+ padding:0;
+ margin:15px 0;
+}
+ul.blockList li.blockList h2 {
+ padding:0px 0 20px 0;
+}
+/*
+Page layout container styles
+*/
+.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer {
+ clear:both;
+ padding:10px 20px;
+ position:relative;
+}
+.indexContainer {
+ margin:10px;
+ position:relative;
+ font-size:12px;
+}
+.indexContainer h2 {
+ font-size:13px;
+ padding:0 0 3px 0;
+}
+.indexContainer ul {
+ margin:0;
+ padding:0;
+}
+.indexContainer ul li {
+ list-style:none;
+ padding-top:2px;
+}
+.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt {
+ font-size:12px;
+ font-weight:bold;
+ margin:10px 0 0 0;
+ color:#4E4E4E;
+}
+.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd {
+ margin:5px 0 10px 0px;
+ font-size:14px;
+ font-family:'DejaVu Sans Mono',monospace;
+}
+.serializedFormContainer dl.nameValue dt {
+ margin-left:1px;
+ font-size:1.1em;
+ display:inline;
+ font-weight:bold;
+}
+.serializedFormContainer dl.nameValue dd {
+ margin:0 0 0 1px;
+ font-size:1.1em;
+ display:inline;
+}
+/*
+List styles
+*/
+ul.horizontal li {
+ display:inline;
+ font-size:0.9em;
+}
+ul.inheritance {
+ margin:0;
+ padding:0;
+}
+ul.inheritance li {
+ display:inline;
+ list-style:none;
+}
+ul.inheritance li ul.inheritance {
+ margin-left:15px;
+ padding-left:15px;
+ padding-top:1px;
+}
+ul.blockList, ul.blockListLast {
+ margin:10px 0 10px 0;
+ padding:0;
+}
+ul.blockList li.blockList, ul.blockListLast li.blockList {
+ list-style:none;
+ margin-bottom:15px;
+ line-height:1.4;
+}
+ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList {
+ padding:0px 20px 5px 10px;
+ border:1px solid #ededed;
+ background-color:#f8f8f8;
+}
+ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList {
+ padding:0 0 5px 8px;
+ background-color:#ffffff;
+ border:none;
+}
+ul.blockList ul.blockList ul.blockList ul.blockList li.blockList {
+ margin-left:0;
+ padding-left:0;
+ padding-bottom:15px;
+ border:none;
+}
+ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast {
+ list-style:none;
+ border-bottom:none;
+ padding-bottom:0;
+}
+table tr td dl, table tr td dl dt, table tr td dl dd {
+ margin-top:0;
+ margin-bottom:1px;
+}
+/*
+Table styles
+*/
+.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary {
+ width:100%;
+ border-left:1px solid #EEE;
+ border-right:1px solid #EEE;
+ border-bottom:1px solid #EEE;
+}
+.overviewSummary, .memberSummary {
+ padding:0px;
+}
+.overviewSummary caption, .memberSummary caption, .typeSummary caption,
+.useSummary caption, .constantsSummary caption, .deprecatedSummary caption {
+ position:relative;
+ text-align:left;
+ background-repeat:no-repeat;
+ color:#253441;
+ font-weight:bold;
+ clear:none;
+ overflow:hidden;
+ padding:0px;
+ padding-top:10px;
+ padding-left:1px;
+ margin:0px;
+ white-space:pre;
+}
+.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link,
+.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link,
+.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover,
+.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover,
+.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active,
+.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active,
+.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited,
+.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited {
+ color:#FFFFFF;
+}
+.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span,
+.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span {
+ white-space:nowrap;
+ padding-top:5px;
+ padding-left:12px;
+ padding-right:12px;
+ padding-bottom:7px;
+ display:inline-block;
+ float:left;
+ background-color:#F8981D;
+ border: none;
+ height:16px;
+}
+.memberSummary caption span.activeTableTab span {
+ white-space:nowrap;
+ padding-top:5px;
+ padding-left:12px;
+ padding-right:12px;
+ margin-right:3px;
+ display:inline-block;
+ float:left;
+ background-color:#F8981D;
+ height:16px;
+}
+.memberSummary caption span.tableTab span {
+ white-space:nowrap;
+ padding-top:5px;
+ padding-left:12px;
+ padding-right:12px;
+ margin-right:3px;
+ display:inline-block;
+ float:left;
+ background-color:#4D7A97;
+ height:16px;
+}
+.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab {
+ padding-top:0px;
+ padding-left:0px;
+ padding-right:0px;
+ background-image:none;
+ float:none;
+ display:inline;
+}
+.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd,
+.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd {
+ display:none;
+ width:5px;
+ position:relative;
+ float:left;
+ background-color:#F8981D;
+}
+.memberSummary .activeTableTab .tabEnd {
+ display:none;
+ width:5px;
+ margin-right:3px;
+ position:relative;
+ float:left;
+ background-color:#F8981D;
+}
+.memberSummary .tableTab .tabEnd {
+ display:none;
+ width:5px;
+ margin-right:3px;
+ position:relative;
+ background-color:#4D7A97;
+ float:left;
+
+}
+.overviewSummary td, .memberSummary td, .typeSummary td,
+.useSummary td, .constantsSummary td, .deprecatedSummary td {
+ text-align:left;
+ padding:0px 0px 12px 10px;
+}
+th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th,
+td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{
+ vertical-align:top;
+ padding-right:0px;
+ padding-top:8px;
+ padding-bottom:3px;
+}
+th.colFirst, th.colLast, th.colOne, .constantsSummary th {
+ background:#dee3e9;
+ text-align:left;
+ padding:8px 3px 3px 7px;
+}
+td.colFirst, th.colFirst {
+ white-space:nowrap;
+ font-size:13px;
+}
+td.colLast, th.colLast {
+ font-size:13px;
+}
+td.colOne, th.colOne {
+ font-size:13px;
+}
+.overviewSummary td.colFirst, .overviewSummary th.colFirst,
+.useSummary td.colFirst, .useSummary th.colFirst,
+.overviewSummary td.colOne, .overviewSummary th.colOne,
+.memberSummary td.colFirst, .memberSummary th.colFirst,
+.memberSummary td.colOne, .memberSummary th.colOne,
+.typeSummary td.colFirst{
+ width:25%;
+ vertical-align:top;
+}
+td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover {
+ font-weight:bold;
+}
+.tableSubHeadingColor {
+ background-color:#EEEEFF;
+}
+.altColor {
+ background-color:#FFFFFF;
+}
+.rowColor {
+ background-color:#EEEEEF;
+}
+/*
+Content styles
+*/
+.description pre {
+ margin-top:0;
+}
+.deprecatedContent {
+ margin:0;
+ padding:10px 0;
+}
+.docSummary {
+ padding:0;
+}
+
+ul.blockList ul.blockList ul.blockList li.blockList h3 {
+ font-style:normal;
+}
+
+div.block {
+ font-size:14px;
+ font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif;
+}
+
+td.colLast div {
+ padding-top:0px;
+}
+
+
+td.colLast a {
+ padding-bottom:3px;
+}
+/*
+Formatting effect styles
+*/
+.sourceLineNo {
+ color:green;
+ padding:0 30px 0 0;
+}
+h1.hidden {
+ visibility:hidden;
+ overflow:hidden;
+ font-size:10px;
+}
+.block {
+ display:block;
+ margin:3px 10px 2px 0px;
+ color:#474747;
+}
+.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink,
+.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel,
+.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink {
+ font-weight:bold;
+}
+.deprecationComment, .emphasizedPhrase, .interfaceName {
+ font-style:italic;
+}
+
+div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase,
+div.block div.block span.interfaceName {
+ font-style:normal;
+}
+
+div.contentContainer ul.blockList li.blockList h2{
+ padding-bottom:0px;
+}