├── src
    └── com
    │   └── vapor
    │       └── hmcompanion
    │           ├── ui
    │               ├── icon.png
    │               ├── DevEditor.java
    │               ├── BidcosInterface.java
    │               ├── RSSI.java
    │               ├── DevRSSIModel.java
    │               ├── RSSIRenderer.java
    │               ├── DevicePopupMenu.java
    │               ├── Device.java
    │               └── MainWin.java
    │           ├── ServerCommandHelp.java
    │           ├── ServerCommandHMScript.java
    │           ├── Attribute.java
    │           ├── ServerCommandQuit.java
    │           ├── ReGaItem.java
    │           ├── ServerCommandNames.java
    │           ├── ServerCommandStats.java
    │           ├── ServerCommandHMRun.java
    │           ├── HMXRMap.java
    │           ├── ServerCommandHMSet.java
    │           ├── ServerCommandMGet.java
    │           ├── ServerCommandCGet.java
    │           ├── ServerCommandGet.java
    │           ├── ServerCommandSet.java
    │           ├── ServerCommandMReq.java
    │           ├── ServerCommandSetParam.java
    │           ├── ServerCommandReq.java
    │           ├── TCLRegaHandler.java
    │           ├── ArgSplitter.java
    │           ├── ServerCommandHMGet.java
    │           ├── ServerCommand.java
    │           ├── AttributeCache.java
    │           ├── HMXRConnection.java
    │           ├── GraphiteInterface.java
    │           ├── Server.java
    │           ├── ReGaDeviceCache.java
    │           ├── HMC.java
    │           ├── HMXRMsg.java
    │           ├── HMXRResponse.java
    │           └── XMLRPCServer.java
├── .classpath
├── .project
├── hmc.jardesc
├── ReadMe.txt
└── LICENSE


/src/com/vapor/hmcompanion/ui/icon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/owagner/hmcompanion/HEAD/src/com/vapor/hmcompanion/ui/icon.png


--------------------------------------------------------------------------------
/.classpath:
--------------------------------------------------------------------------------
1 | <?xml version="1.0" encoding="UTF-8"?>
2 | <classpath>
3 | 	<classpathentry kind="src" path="src"/>
4 | 	<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER"/>
5 | 	<classpathentry kind="output" path="eclipsebuild"/>
6 | </classpath>
7 | 


--------------------------------------------------------------------------------
/.project:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <projectDescription>
 3 | 	<name>hmcompanion</name>
 4 | 	<comment></comment>
 5 | 	<projects>
 6 | 	</projects>
 7 | 	<buildSpec>
 8 | 		<buildCommand>
 9 | 			<name>org.eclipse.jdt.core.javabuilder</name>
10 | 			<arguments>
11 | 			</arguments>
12 | 		</buildCommand>
13 | 	</buildSpec>
14 | 	<natures>
15 | 		<nature>org.eclipse.jdt.core.javanature</nature>
16 | 	</natures>
17 | </projectDescription>
18 | 


--------------------------------------------------------------------------------
/src/com/vapor/hmcompanion/ServerCommandHelp.java:
--------------------------------------------------------------------------------
 1 | package com.vapor.hmcompanion;
 2 | 
 3 | public class ServerCommandHelp extends ServerCommand
 4 | {
 5 | 	ServerCommandHelp()
 6 | 	{
 7 | 		super("HELP","Show all commands");
 8 | 	}
 9 | 
10 | 	@Override
11 | 	public void exec(Server s, ArgSplitter args) throws Exception
12 | 	{
13 | 		for(ServerCommand sc:commands.values())
14 | 		{
15 | 			s.send(sc.cmd+"\t"+sc.desc);
16 | 		}
17 | 	}
18 | 
19 | }
20 | 


--------------------------------------------------------------------------------
/src/com/vapor/hmcompanion/ServerCommandHMScript.java:
--------------------------------------------------------------------------------
 1 | package com.vapor.hmcompanion;
 2 | 
 3 | public class ServerCommandHMScript extends ServerCommand
 4 | {
 5 | 	ServerCommandHMScript()
 6 | 	{
 7 | 		super("HMSCRIPT","<script> - execute HMScript");
 8 | 	}
 9 | 
10 | 	@Override
11 | 	public void exec(Server s, ArgSplitter args) throws Exception
12 | 	{
13 | 		if(args.args.length<1)
14 | 		{
15 | 			s.send("-Missing argument <script>");
16 | 			return;
17 | 		}
18 | 		s.send(TCLRegaHandler.sendHMScript(args.fullLine));
19 | 		s.send(".");
20 | 	}
21 | 
22 | }
23 | 


--------------------------------------------------------------------------------
/src/com/vapor/hmcompanion/Attribute.java:
--------------------------------------------------------------------------------
 1 | /*
 2 |  * Represents one attribute and it's metadata
 3 |  */
 4 | 
 5 | package com.vapor.hmcompanion;
 6 | 
 7 | import java.io.*;
 8 | import java.util.*;
 9 | 
10 | public class Attribute implements Serializable
11 | {
12 | 	Object value;
13 | 	Date lastUpdate;
14 | 	Date lastChange;
15 | 
16 | 	public void set(Object nv)
17 | 	{
18 | 		lastUpdate=new Date();
19 | 		if(value==null||!value.equals(nv))
20 | 			lastChange=lastUpdate;
21 | 		value=nv;
22 | 	}
23 | 
24 | 	@Override
25 | 	public String toString()
26 | 	{
27 | 		return value.toString();
28 | 	}
29 | }
30 | 


--------------------------------------------------------------------------------
/src/com/vapor/hmcompanion/ServerCommandQuit.java:
--------------------------------------------------------------------------------
 1 | package com.vapor.hmcompanion;
 2 | 
 3 | import java.io.*;
 4 | 
 5 | public class ServerCommandQuit extends ServerCommand
 6 | {
 7 | 	ServerCommandQuit()
 8 | 	{
 9 | 		super("QUIT","Terminate this session (-exit to terminate HMC)");
10 | 	}
11 | 
12 | 	@Override
13 | 	public void exec(Server s, ArgSplitter args) throws Exception
14 | 	{
15 | 		if(args.args.length>0)
16 | 		{
17 | 			if("-exit".equalsIgnoreCase(args.args[0]))
18 | 			{
19 | 				HMC.l.info("Shutting down on command");
20 | 				System.exit(0);
21 | 			}
22 | 		}
23 | 		throw new EOFException();
24 | 	}
25 | 
26 | }
27 | 


--------------------------------------------------------------------------------
/src/com/vapor/hmcompanion/ReGaItem.java:
--------------------------------------------------------------------------------
 1 | package com.vapor.hmcompanion;
 2 | 
 3 | class ReGaItem implements Comparable<ReGaItem>
 4 | {
 5 | 	int id;
 6 | 	String name;
 7 | 	String address;
 8 | 	String interf;
 9 | 	ReGaItem(int id, String name, String address, String interf)
10 | 	{
11 | 		this.id = id;
12 | 		this.name = name;
13 | 		this.address = address;
14 | 		this.interf = interf;
15 | 	}
16 | 
17 | 	@Override
18 | 	public String toString()
19 | 	{
20 | 		return "["+id+":"+name+"/"+address+"/"+interf+"]";
21 | 	}
22 | 
23 | 	@Override
24 | 	public int compareTo(ReGaItem o)
25 | 	{
26 | 		return name.compareTo(o.name);
27 | 	}
28 | }


--------------------------------------------------------------------------------
/src/com/vapor/hmcompanion/ServerCommandNames.java:
--------------------------------------------------------------------------------
 1 | package com.vapor.hmcompanion;
 2 | 
 3 | import java.util.*;
 4 | 
 5 | public class ServerCommandNames extends ServerCommand
 6 | {
 7 | 	ServerCommandNames()
 8 | 	{
 9 | 		super("NAMES","Dump all ReGa names");
10 | 	}
11 | 
12 | 	@Override
13 | 	public void exec(Server s, ArgSplitter args) throws Exception
14 | 	{
15 | 		// Sort by name
16 | 		List<ReGaItem> templist=new ArrayList<ReGaItem>(ReGaDeviceCache.itemsByName.values());
17 | 		Collections.sort(templist);
18 | 
19 | 		for(ReGaItem it:templist)
20 | 			s.send(it.name+"\t"+it.address+"\t"+it.interf);
21 | 		s.send(".");
22 | 	}
23 | }
24 | 


--------------------------------------------------------------------------------
/src/com/vapor/hmcompanion/ServerCommandStats.java:
--------------------------------------------------------------------------------
 1 | package com.vapor.hmcompanion;
 2 | 
 3 | public class ServerCommandStats extends ServerCommand
 4 | {
 5 | 	ServerCommandStats()
 6 | 	{
 7 | 		super("STATS","Get statistics");
 8 | 	}
 9 | 
10 | 	@Override
11 | 	public void exec(Server s, ArgSplitter args) throws Exception
12 | 	{
13 | 		StringBuilder res=new StringBuilder();
14 | 
15 | 		res.append("MSGWIRED:");
16 | 		res.append(XMLRPCServer.getStats("CB0"));
17 | 		res.append(" MSGRF:");
18 | 		res.append(XMLRPCServer.getStats("CB1"));
19 | 		res.append(" MSGPFMD:");
20 | 		res.append(XMLRPCServer.getStats("CB2"));
21 | 
22 | 		s.send(res.toString());
23 | 	}
24 | }
25 | 


--------------------------------------------------------------------------------
/src/com/vapor/hmcompanion/ui/DevEditor.java:
--------------------------------------------------------------------------------
 1 | package com.vapor.hmcompanion.ui;
 2 | 
 3 | import java.util.*;
 4 | 
 5 | import javax.swing.*;
 6 | 
 7 | public class DevEditor extends JFrame
 8 | {
 9 | 	static Map<Device,DevEditor> editors=new HashMap<Device,DevEditor>();
10 | 
11 | 	private Device myDevice;
12 | 	public DevEditor(Device d)
13 | 	{
14 | 		super("Editing "+d.address+ "("+d.name+")");
15 | 		myDevice=d;
16 | 	}
17 | 
18 | 	static public void editDevice(Device d)
19 | 	{
20 | 		DevEditor de=editors.get(d);
21 | 		if(de!=null)
22 | 		{
23 | 			de.setVisible(true);
24 | 			return;
25 | 		}
26 | 		de=new DevEditor(d);
27 | 		editors.put(d,de);
28 | 	}
29 | }
30 | 


--------------------------------------------------------------------------------
/src/com/vapor/hmcompanion/ServerCommandHMRun.java:
--------------------------------------------------------------------------------
 1 | package com.vapor.hmcompanion;
 2 | 
 3 | public class ServerCommandHMRun extends ServerCommand
 4 | {
 5 | 	ServerCommandHMRun()
 6 | 	{
 7 | 		super("HMRUN","<program> [<program2>...] - execute HMScript programs");
 8 | 	}
 9 | 
10 | 	@Override
11 | 	public void exec(Server s, ArgSplitter args) throws Exception
12 | 	{
13 | 		if(args.args.length<1)
14 | 		{
15 | 			s.send("-Missing argument <program>");
16 | 			return;
17 | 		}
18 | 		for(String a:args.args)
19 | 		{
20 | 			StringBuilder script=new StringBuilder();
21 | 			script.append("Write(dom.GetObject(\"");
22 | 			script.append(a);
23 | 			script.append("\").ProgramExecute());");
24 | 			s.send(TCLRegaHandler.sendHMScript(script.toString()));
25 | 		}
26 | 		s.send(".");
27 | 	}
28 | 
29 | }
30 | 


--------------------------------------------------------------------------------
/src/com/vapor/hmcompanion/HMXRMap.java:
--------------------------------------------------------------------------------
 1 | package com.vapor.hmcompanion;
 2 | 
 3 | import java.util.*;
 4 | 
 5 | @SuppressWarnings("serial")
 6 | public class HMXRMap extends TreeMap<String, Object>
 7 | {
 8 | 	@SuppressWarnings("boxing")
 9 | 	public boolean getBool(String k)
10 | 	{
11 | 		Boolean b=(Boolean)get(k);
12 | 		if(b!=null)
13 | 			return b;
14 | 		else
15 | 			return false;
16 | 	}
17 | 
18 | 	public int getInt(String k)
19 | 	{
20 | 		Integer i=(Integer)get(k);
21 | 		if(i!=null)
22 | 			return i.intValue();
23 | 		else
24 | 			return -1;
25 | 	}
26 | 
27 | 	public double getDouble(String k)
28 | 	{
29 | 		Number d=(Number)get(k);
30 | 		if(d!=null)
31 | 			return d.doubleValue();
32 | 		else
33 | 			return -1;
34 | 	}
35 | 
36 | 	public String getString(String k)
37 | 	{
38 | 		return (String)get(k);
39 | 	}
40 | }
41 | 


--------------------------------------------------------------------------------
/src/com/vapor/hmcompanion/ServerCommandHMSet.java:
--------------------------------------------------------------------------------
 1 | package com.vapor.hmcompanion;
 2 | 
 3 | public class ServerCommandHMSet extends ServerCommand
 4 | {
 5 | 	ServerCommandHMSet()
 6 | 	{
 7 | 		super("HMSET","<variable> <value> - Set HMScript system variable");
 8 | 	}
 9 | 
10 | 	@Override
11 | 	public void exec(Server s, ArgSplitter args) throws Exception
12 | 	{
13 | 		if(args.args.length!=2)
14 | 		{
15 | 			s.send("-specify two arguments: variable value");
16 | 			return;
17 | 		}
18 | 		StringBuilder script=new StringBuilder();
19 | 		script.append("Write(dom.GetObject(\"");
20 | 		script.append(args.args[0]);
21 | 		script.append("\").State(\"");
22 | 
23 | 		String a=args.args[1];
24 | 		a=a.replace("\\","\\\\");
25 | 		a=a.replace("\"","\\\"");
26 | 
27 | 		script.append(a);
28 | 		script.append("\"));");
29 | 
30 | 		s.send(TCLRegaHandler.sendHMScript(script.toString()));
31 | 		s.send(".");
32 | 	}
33 | 
34 | }
35 | 


--------------------------------------------------------------------------------
/src/com/vapor/hmcompanion/ServerCommandMGet.java:
--------------------------------------------------------------------------------
 1 | package com.vapor.hmcompanion;
 2 | 
 3 | import java.util.*;
 4 | 
 5 | public class ServerCommandMGet extends ServerCommand
 6 | {
 7 | 	ServerCommandMGet()
 8 | 	{
 9 | 		super("MGET","<channel name wildcard> <attribute>\tget attribute from multiple channels");
10 | 	}
11 | 
12 | 	@Override
13 | 	public void exec(Server s, ArgSplitter args) throws Exception
14 | 	{
15 | 		if(args.args.length!=2)
16 | 		{
17 | 			s.send("-Missing argument <channel> <attribute>");
18 | 			return;
19 | 		}
20 | 		Collection<ReGaItem> items=ReGaDeviceCache.getItemsByName(args.args[0]);
21 | 		if(items==null)
22 | 		{
23 | 			s.send("-Unable to identify channel "+args.args[0]);
24 | 			return;
25 | 		}
26 | 		for(ReGaItem it:items)
27 | 		{
28 | 			Object v=AttributeCache.getAttribute(it.address,args.args[1].toUpperCase());
29 | 			if(v!=null)
30 | 				s.send(it.name+":"+v.toString());
31 | 			else
32 | 				s.send(it.name+":");
33 | 		}
34 | 		s.send(".");
35 | 	}
36 | }
37 | 


--------------------------------------------------------------------------------
/hmc.jardesc:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8" standalone="no"?>
 2 | <jardesc>
 3 |     <jar path="c:/temp/hmcompanion.jar"/>
 4 |     <options buildIfNeeded="true" compress="true" descriptionLocation="/hmcompanion/hmc.jardesc" exportErrors="true" exportWarnings="true" includeDirectoryEntries="false" overwrite="true" saveDescription="true" storeRefactorings="false" useSourceFolders="false"/>
 5 |     <storedRefactorings deprecationInfo="true" structuralOnly="false"/>
 6 |     <selectedProjects/>
 7 |     <manifest generateManifest="true" mainClassHandleIdentifier="=hmcompanion/src&lt;com.vapor.hmcompanion{HMC.java[HMC" manifestLocation="" manifestVersion="1.0" reuseManifest="false" saveManifest="false" usesManifest="true">
 8 |         <sealing sealJar="false">
 9 |             <packagesToSeal/>
10 |             <packagesToUnSeal/>
11 |         </sealing>
12 |     </manifest>
13 |     <selectedElements exportClassFiles="true" exportJavaFiles="false" exportOutputFolder="false">
14 |         <javaElement handleIdentifier="=hmcompanion/src"/>
15 |     </selectedElements>
16 | </jardesc>
17 | 


--------------------------------------------------------------------------------
/src/com/vapor/hmcompanion/ServerCommandCGet.java:
--------------------------------------------------------------------------------
 1 | package com.vapor.hmcompanion;
 2 | 
 3 | import java.util.*;
 4 | 
 5 | public class ServerCommandCGet extends ServerCommand
 6 | {
 7 | 	ServerCommandCGet()
 8 | 	{
 9 | 		super("CGET","<channel name or address> get channel attributes in Cacti script format");
10 | 	}
11 | 
12 | 	@Override
13 | 	public void exec(Server s, ArgSplitter args) throws Exception
14 | 	{
15 | 		if(args.args.length<1)
16 | 		{
17 | 			s.send("-Missing argument <channel>");
18 | 			return;
19 | 		}
20 | 		String dev=parseAddress(args.args[0]);
21 | 		Map<String,Attribute> attr=AttributeCache.getAllAttributes(dev);
22 | 		StringBuilder res=new StringBuilder();
23 | 		if(attr!=null)
24 | 			for(Map.Entry<String,Attribute> me:attr.entrySet())
25 | 			{
26 | 				if(res.length()>0)
27 | 					res.append(' ');
28 | 				res.append(me.getKey());
29 | 				res.append(':');
30 | 				Attribute a=me.getValue();
31 | 				if(a.value instanceof Boolean)
32 | 					res.append(((Boolean)a.value).booleanValue()?"1":"0");
33 | 				else
34 | 					res.append(me.getValue());
35 | 			}
36 | 		s.send(res.toString());
37 | 	}
38 | 
39 | }
40 | 


--------------------------------------------------------------------------------
/src/com/vapor/hmcompanion/ServerCommandGet.java:
--------------------------------------------------------------------------------
 1 | package com.vapor.hmcompanion;
 2 | 
 3 | import java.util.*;
 4 | 
 5 | public class ServerCommandGet extends ServerCommand
 6 | {
 7 | 	ServerCommandGet()
 8 | 	{
 9 | 		super("GET","<channel name or address> [<attribute> [<attributes...>]\tget attribute(s) from channel");
10 | 	}
11 | 
12 | 	@Override
13 | 	public void exec(Server s, ArgSplitter args) throws Exception
14 | 	{
15 | 		if(args.args.length<1)
16 | 		{
17 | 			s.send("-Missing argument <channel>");
18 | 			return;
19 | 		}
20 | 		String dev=parseAddress(args.args[0]);
21 | 		if(args.args.length==1)
22 | 		{
23 | 			Map<String,Attribute> attr=AttributeCache.getAllAttributes(dev);
24 | 			if(attr!=null)
25 | 				for(Map.Entry<String,Attribute> me:attr.entrySet())
26 | 					s.send(me.getKey()+":"+me.getValue());
27 | 			s.send(".");
28 | 		}
29 | 		else
30 | 		{
31 | 			for(int ix=1;ix<args.args.length;ix++)
32 | 			{
33 | 				Object v=AttributeCache.getAttribute(dev,args.args[ix].toUpperCase());
34 | 				if(v!=null)
35 | 					s.send(v.toString());
36 | 				else
37 | 					s.send("");
38 | 			}
39 | 		}
40 | 	}
41 | 
42 | }
43 | 


--------------------------------------------------------------------------------
/src/com/vapor/hmcompanion/ServerCommandSet.java:
--------------------------------------------------------------------------------
 1 | package com.vapor.hmcompanion;
 2 | 
 3 | import java.util.*;
 4 | 
 5 | public class ServerCommandSet extends ServerCommand
 6 | {
 7 | 	ServerCommandSet()
 8 | 	{
 9 | 		super("SET","<channel name or address> <attribute> <value> - shortcut for setValue xmlrpc request");
10 | 	}
11 | 
12 | 	@Override
13 | 	public void exec(Server s, ArgSplitter args) throws Exception
14 | 	{
15 | 		if(args.args.length<3)
16 | 		{
17 | 			s.send("-Missing arguments");
18 | 			return;
19 | 		}
20 | 		Collection<ReGaItem> items=ReGaDeviceCache.getItemsByName(args.args[0]);
21 | 		if(items==null)
22 | 		{
23 | 			s.send("-Unable to identify channel "+args.args[0]);
24 | 			return;
25 | 		}
26 | 		for(ReGaItem it:items)
27 | 		{
28 | 			int dix;
29 | 			if("BidCos-RF".equals(it.interf))
30 | 				dix=1;
31 | 			else if("BidCos-Wired".equals(it.interf))
32 | 				dix=0;
33 | 			else if("CUxD".equals(it.interf))
34 | 				dix=3;
35 | 			else
36 | 				dix=2;
37 | 
38 | 			HMXRMsg m=new HMXRMsg("setValue");
39 | 			m.addArg(it.address);
40 | 			m.addArg(args.args[1]);
41 | 			m.addArgWithTypeGuessing(args.args[2]);
42 | 
43 | 			HMXRResponse r=HMC.connections[dix].sendRequest(m);
44 | 			// Ignore response
45 | 		}
46 | 	}
47 | }
48 | 


--------------------------------------------------------------------------------
/src/com/vapor/hmcompanion/ServerCommandMReq.java:
--------------------------------------------------------------------------------
 1 | package com.vapor.hmcompanion;
 2 | 
 3 | public class ServerCommandMReq extends ServerCommand
 4 | {
 5 | 	ServerCommandMReq()
 6 | 	{
 7 | 		super("REQ","<RF|WIRE|SYS> <method> <parameters> - send xmlrpc request");
 8 | 	}
 9 | 
10 | 	@Override
11 | 	public void exec(Server s, ArgSplitter args) throws Exception
12 | 	{
13 | 		if(args.args.length<2)
14 | 		{
15 | 			s.send("-Missing arguments <type> <method>");
16 | 			return;
17 | 		}
18 | 		int dix;
19 | 		switch(args.args[0].charAt(0))
20 | 		{
21 | 			case 'r':
22 | 			case 'R':
23 | 				dix=1;
24 | 				break;
25 | 			case 'w':
26 | 			case 'W':
27 | 				dix=0;
28 | 				break;
29 | 			case 's':
30 | 			case 'S':
31 | 				dix=2;
32 | 				break;
33 | 			default:
34 | 				s.send("-Invalid type, must be RF, WIRE or SYS");
35 | 				return;
36 | 		}
37 | 
38 | 		// Add arguments, with some type guessing:
39 | 		// on|true off|false -> Boolean
40 | 		// Integer number (without point)
41 | 		// Decimal number (with point)
42 | 		// everything else: String
43 | 		HMXRMsg m=new HMXRMsg(args.args[1]);
44 | 		for(int c=2;c<args.args.length;c++)
45 | 		{
46 | 			String v=args.args[c];
47 | 			m.addArgWithTypeGuessing(v);
48 | 		}
49 | 
50 | 		HMXRResponse r=HMC.connections[dix].sendRequest(m);
51 | 		s.send(r.toString());
52 | 		s.send(".");
53 | 	}
54 | 
55 | }
56 | 


--------------------------------------------------------------------------------
/src/com/vapor/hmcompanion/ui/BidcosInterface.java:
--------------------------------------------------------------------------------
 1 | package com.vapor.hmcompanion.ui;
 2 | 
 3 | import java.util.*;
 4 | 
 5 | import com.vapor.hmcompanion.*;
 6 | 
 7 | public class BidcosInterface
 8 | {
 9 | 	String address;
10 | 	boolean connected;
11 | 	boolean def;
12 | 	String description;
13 | 
14 | 	static Map<String,BidcosInterface> interfaces=new TreeMap<String,BidcosInterface>();
15 | 	static List<BidcosInterface> interfaceList=Collections.emptyList();
16 | 
17 | 	private BidcosInterface(String address, String description, boolean connected, boolean def)
18 | 	{
19 | 		this.address = address;
20 | 		this.connected = connected;
21 | 		this.def = def;
22 | 		this.description = description;
23 | 	}
24 | 
25 | 	static void loadInterfacelist()
26 | 	{
27 | 		HMXRMsg m=new HMXRMsg("listBidcosInterfaces");
28 | 		HMXRResponse r=MainWin.doRequest(m);
29 | 		Map<String,BidcosInterface> interfaces=new TreeMap<String,BidcosInterface>();
30 | 		for(Object mi:(List<?>)r.getData().get(0))
31 | 		{
32 | 			HMXRMap o=(HMXRMap)mi;
33 | 
34 | 			BidcosInterface bi=new BidcosInterface(
35 | 				o.getString("ADDRESS"),
36 | 				o.getString("DESCRIPTION"),
37 | 				o.getBool("CONNECTED"),
38 | 				o.getBool("DEFAULT")
39 | 			);
40 | 
41 | 			interfaces.put(bi.address,bi);
42 | 		}
43 | 		BidcosInterface.interfaces=interfaces;
44 | 		BidcosInterface.interfaceList=new ArrayList<BidcosInterface>(interfaces.values());
45 | 	}
46 | }
47 | 


--------------------------------------------------------------------------------
/src/com/vapor/hmcompanion/ServerCommandSetParam.java:
--------------------------------------------------------------------------------
 1 | package com.vapor.hmcompanion;
 2 | 
 3 | import java.util.*;
 4 | 
 5 | public class ServerCommandSetParam extends ServerCommand
 6 | {
 7 | 	ServerCommandSetParam()
 8 | 	{
 9 | 		super("SETPARAM","<channel name or address> <attribute> <value> - shortcut for putParamset xmlrpc request");
10 | 	}
11 | 
12 | 	@Override
13 | 	public void exec(Server s, ArgSplitter args) throws Exception
14 | 	{
15 | 		if(args.args.length<4)
16 | 		{
17 | 			s.send("-Missing arguments");
18 | 			return;
19 | 		}
20 | 		Collection<ReGaItem> items=ReGaDeviceCache.getItemsByName(args.args[0]);
21 | 		if(items==null)
22 | 		{
23 | 			s.send("-Unable to identify channel "+args.args[0]);
24 | 			return;
25 | 		}
26 | 		for(ReGaItem it:items)
27 | 		{
28 | 			int dix;
29 | 			if("BidCos-RF".equals(it.interf))
30 | 				dix=1;
31 | 			else if("BidCos-Wired".equals(it.interf))
32 | 				dix=0;
33 | 			else if("CUxD".equals(it.interf))
34 | 				dix=3;
35 | 			else
36 | 				dix=2;
37 | 
38 | 			HMXRMsg m=new HMXRMsg("putParamset");
39 | 			m.addArg(it.address);
40 | 			m.addArg(args.args[1]); // Paramset name (MASTER)
41 | 			// Build a map with the Paramset
42 | 			Map<String,Object> map=new HashMap<String,Object>();
43 | 			map.put(args.args[2],m.guessType(args.args[3]));
44 | 			m.addArg(map);
45 | 
46 | 			HMXRResponse r=HMC.connections[dix].sendRequest(m);
47 | 			// Ignore response
48 | 		}
49 | 	}
50 | }
51 | 


--------------------------------------------------------------------------------
/src/com/vapor/hmcompanion/ServerCommandReq.java:
--------------------------------------------------------------------------------
 1 | package com.vapor.hmcompanion;
 2 | 
 3 | public class ServerCommandReq extends ServerCommand
 4 | {
 5 | 	ServerCommandReq()
 6 | 	{
 7 | 		super("REQ","<RF|WIRE|SYS|CUXD> <method> <parameters> - send xmlrpc request");
 8 | 	}
 9 | 
10 | 	@Override
11 | 	public void exec(Server s, ArgSplitter args) throws Exception
12 | 	{
13 | 		if(args.args.length<2)
14 | 		{
15 | 			s.send("-Missing arguments <type> <method>");
16 | 			return;
17 | 		}
18 | 		int dix;
19 | 		switch(args.args[0].charAt(0))
20 | 		{
21 | 			case 'c':
22 | 			case 'C':
23 | 				dix=3;
24 | 				break;
25 | 			case 'r':
26 | 			case 'R':
27 | 				dix=1;
28 | 				break;
29 | 			case 'w':
30 | 			case 'W':
31 | 				dix=0;
32 | 				break;
33 | 			case 's':
34 | 			case 'S':
35 | 				dix=2;
36 | 				break;
37 | 			default:
38 | 				s.send("-Invalid type, must be RF, WIRE, CUXD or SYS");
39 | 				return;
40 | 		}
41 | 
42 | 		// Add arguments, with some type guessing:
43 | 		// on|true off|false -> Boolean
44 | 		// Integer number (without point)
45 | 		// Decimal number (with point)
46 | 		// everything else: String
47 | 		HMXRMsg m=new HMXRMsg(args.args[1]);
48 | 		for(int c=2;c<args.args.length;c++)
49 | 		{
50 | 			String v=args.args[c];
51 | 			m.addArgWithTypeGuessing(v);
52 | 		}
53 | 
54 | 		HMXRResponse r=HMC.connections[dix].sendRequest(m);
55 | 		s.send(r.toString());
56 | 		s.send(".");
57 | 	}
58 | 
59 | }
60 | 


--------------------------------------------------------------------------------
/src/com/vapor/hmcompanion/TCLRegaHandler.java:
--------------------------------------------------------------------------------
 1 | /*
 2 |  * Class to send a HMScript request to the CCU
 3 |  * using the tclrega.exe executor
 4 |  */
 5 | 
 6 | package com.vapor.hmcompanion;
 7 | 
 8 | import java.io.*;
 9 | import java.net.*;
10 | import java.util.logging.*;
11 | 
12 | public class TCLRegaHandler
13 | {
14 | 	static URL url;
15 | 	public static void setHMHost(String host) throws MalformedURLException
16 | 	{
17 | 		url=new URL("http://"+host+":8181/tclrega.exe");
18 | 	}
19 | 
20 | 	public static String sendHMScript(String script)
21 | 	{
22 | 		try
23 | 		{
24 | 			HttpURLConnection con=(HttpURLConnection)url.openConnection();
25 | 			con.setRequestMethod("POST");
26 | 			con.setDoOutput(true);
27 | 			con.getOutputStream().write(script.getBytes("ISO-8859-1"));
28 | 			con.getOutputStream().close();
29 | 			BufferedReader br=new BufferedReader(new InputStreamReader(con.getInputStream(),"ISO-8859-1"));
30 | 			StringBuilder reply=new StringBuilder();
31 | 			String l;
32 | 			while((l=br.readLine())!=null)
33 | 			{
34 | 				if(l.length()>0)
35 | 				{
36 | 					l=l.replaceAll("<xml><exec>.*</xml>","");
37 | 					if(l.length()==0)
38 | 						break;
39 | 				}
40 | 				reply.append(l.trim());
41 | 				reply.append('\n');
42 | 			}
43 | 			br.close();
44 | 			return reply.toString().trim();
45 | 		}
46 | 		catch(Exception e)
47 | 		{
48 | 			HMC.l.log(Level.WARNING,"Unable to send tclrega-request",e);
49 | 			return null;
50 | 		}
51 | 	}
52 | }
53 | 


--------------------------------------------------------------------------------
/src/com/vapor/hmcompanion/ArgSplitter.java:
--------------------------------------------------------------------------------
 1 | package com.vapor.hmcompanion;
 2 | 
 3 | import java.util.*;
 4 | 
 5 | public class ArgSplitter
 6 | {
 7 | 	String args[];
 8 | 	String fullLine;
 9 | 
10 | 	public ArgSplitter(String line)
11 | 	{
12 | 		ArrayList<String> parsed=new ArrayList<String>();
13 | 		this.fullLine=line;
14 | 
15 | 		StringBuilder arg=null;
16 | 		boolean inQuotedString=false;
17 | 		for(int ix=0;ix<line.length();ix++)
18 | 		{
19 | 			if(arg==null)
20 | 				arg=new StringBuilder();
21 | 			char ch=line.charAt(ix);
22 | 
23 | 			if(ch=='\\')
24 | 			{
25 | 				ix++;
26 | 				arg.append(line.charAt(ix));
27 | 				continue;
28 | 			}
29 | 
30 | 			if(inQuotedString)
31 | 			{
32 | 				if(ch=='"')
33 | 				{
34 | 					// We also add empty strings here, unlike in the unquoted branch
35 | 					parsed.add(arg.toString());
36 | 					arg=null;
37 | 					inQuotedString=false;
38 | 				}
39 | 				else
40 | 					arg.append(ch);
41 | 			}
42 | 			else
43 | 			{
44 | 				if(ch==' ')
45 | 				{
46 | 					if(arg.length()>0)
47 | 					{
48 | 						parsed.add(arg.toString());
49 | 					}
50 | 					arg=null;
51 | 				}
52 | 				else if(ch=='"' && arg.length()==0)
53 | 				{
54 | 					// Quote at beginning of string only
55 | 					inQuotedString=true;
56 | 					continue;
57 | 				}
58 | 				else
59 | 					arg.append(ch);
60 | 			}
61 | 		}
62 | 		if(arg!=null)
63 | 			parsed.add(arg.toString());
64 | 		args=parsed.toArray(new String[parsed.size()]);
65 | 	}
66 | }
67 | 


--------------------------------------------------------------------------------
/src/com/vapor/hmcompanion/ServerCommandHMGet.java:
--------------------------------------------------------------------------------
 1 | package com.vapor.hmcompanion;
 2 | 
 3 | import java.util.*;
 4 | import java.text.*;
 5 | 
 6 | public class ServerCommandHMGet extends ServerCommand
 7 | {
 8 | 	ServerCommandHMGet()
 9 | 	{
10 | 		super("HMGET","<variable> [<variable2>...|-timestamp|-timestampts] - get HMScript system variable/timestamps");
11 | 	}
12 | 
13 | 	private DateFormat hmcformat=new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
14 | 
15 | 	@Override
16 | 	public void exec(Server s, ArgSplitter args) throws Exception
17 | 	{
18 | 		boolean timestamp=false, timestampts=false, state=false;
19 | 
20 | 		if(args.args.length<1)
21 | 		{
22 | 			s.send("-Missing argument <variable>");
23 | 			return;
24 | 		}
25 | 		for(String a:args.args)
26 | 		{
27 | 			if("-timestamp".equalsIgnoreCase(a))
28 | 			{
29 | 				timestamp=true;
30 | 				continue;
31 | 			}
32 | 			else if("-timestampts".equalsIgnoreCase(a))
33 | 			{
34 | 				timestampts=true;
35 | 				continue;
36 | 			}
37 | 			else if("-state".equalsIgnoreCase(a))
38 | 			{
39 | 				state=true;
40 | 				continue;
41 | 			}
42 | 
43 | 			StringBuilder script=new StringBuilder();
44 | 			script.append("Write(dom.GetObject(\"");
45 | 			script.append(a);
46 | 			script.append("\").");
47 | 			script.append((timestamp||timestampts)?"Timestamp":(state?"State":"Variable"));
48 | 			script.append("());");
49 | 			String reply=TCLRegaHandler.sendHMScript(script.toString());
50 | 			if(timestampts)
51 | 			{
52 | 				Date d=hmcformat.parse(reply);
53 | 				if(d!=null)
54 | 					s.send(String.valueOf(d.getTime()/1000));
55 | 				else
56 | 					s.send("");
57 | 			}
58 | 			else
59 | 				s.send(reply);
60 | 		}
61 | 		s.send(".");
62 | 	}
63 | }
64 | 


--------------------------------------------------------------------------------
/src/com/vapor/hmcompanion/ui/RSSI.java:
--------------------------------------------------------------------------------
 1 | package com.vapor.hmcompanion.ui;
 2 | 
 3 | import java.util.*;
 4 | 
 5 | import com.vapor.hmcompanion.*;
 6 | 
 7 | public class RSSI
 8 | {
 9 | 	static class RSSIInfo
10 | 	{
11 | 		int from=65536;
12 | 		int to=65536;
13 | 		boolean isDef,isBest,isWrong;
14 | 		private RSSIInfo(int from, int to)
15 | 		{
16 | 			this.from = from;
17 | 			this.to = to;
18 | 		}
19 | 		public RSSIInfo()
20 | 		{
21 | 			/* Ignore */
22 | 		}
23 | 
24 | 		public int cmpVal()
25 | 		{
26 | 			if(from!=65536 && to!=65536)
27 | 				return (from+to)/2;
28 | 			else if(from!=65536)
29 | 				return from;
30 | 			else if(to!=65536)
31 | 				return to;
32 | 			else
33 | 				return Integer.MIN_VALUE;
34 | 		}
35 | 	}
36 | 
37 | 	static Map<String,Map<String,RSSIInfo>> rssi=Collections.emptyMap();
38 | 
39 | 	@SuppressWarnings("boxing")
40 | 	static void loadRSSIInfo()
41 | 	{
42 | 		HMXRMsg m=new HMXRMsg("rssiInfo");
43 | 		HMXRResponse r=MainWin.doRequest(m);
44 | 
45 | 		Map<String,Map<String,RSSIInfo>> rssi=new HashMap<String,Map<String,RSSIInfo>>();
46 | 
47 | 		HMXRMap map=(HMXRMap)r.getData().get(0);
48 | 		for(Map.Entry<String,Object> im:map.entrySet())
49 | 		{
50 | 			// Create the inner map
51 | 			Map<String,RSSIInfo> rm=new HashMap<String,RSSIInfo>();
52 | 			rssi.put(im.getKey(),rm);
53 | 
54 | 			for(Map.Entry<String,Object> cim:((HMXRMap)im.getValue()).entrySet())
55 | 			{
56 | 				String ik=cim.getKey();
57 | 
58 | 				List<?> l=(List<?>)cim.getValue();
59 | 
60 | 				RSSIInfo rsi=new RSSIInfo((Integer)l.get(0),(Integer)l.get(1));
61 | 				rm.put(ik,rsi);
62 | 			}
63 | 
64 | 		}
65 | 
66 | 		RSSI.rssi=rssi;
67 | 		Device.setRSSI(rssi);
68 | 	}
69 | 
70 | 
71 | }
72 | 


--------------------------------------------------------------------------------
/src/com/vapor/hmcompanion/ServerCommand.java:
--------------------------------------------------------------------------------
 1 | package com.vapor.hmcompanion;
 2 | 
 3 | import java.util.*;
 4 | 
 5 | public abstract class ServerCommand
 6 | {
 7 | 	static Map<String,ServerCommand> commands=new HashMap<String,ServerCommand>();
 8 | 
 9 | 	static ServerCommand get(String cmd)
10 | 	{
11 | 		return commands.get(cmd);
12 | 	}
13 | 	static private void add(ServerCommand sc)
14 | 	{
15 | 		commands.put(sc.cmd,sc);
16 | 	}
17 | 	static void initCommands()
18 | 	{
19 | 		add(new ServerCommandHelp());
20 | 		add(new ServerCommandQuit());
21 | 		add(new ServerCommandCGet());
22 | 		add(new ServerCommandGet());
23 | 		add(new ServerCommandMGet());
24 | 		add(new ServerCommandSet());
25 | 		add(new ServerCommandSetParam());
26 | 		add(new ServerCommandReq());
27 | 		add(new ServerCommandHMScript());
28 | 		add(new ServerCommandHMSet());
29 | 		add(new ServerCommandHMGet());
30 | 		add(new ServerCommandHMRun());
31 | 		add(new ServerCommandNames());
32 | 		add(new ServerCommandStats());
33 | 	}
34 | 
35 | 	/* Helpers */
36 | 	static String parseAddress(String name)
37 | 	{
38 | 		// Is name already a BidCoS address?
39 | 		if(name.matches("[A-Z]{3}[0-9]{7}(:[0-9]+)?"))
40 | 			return name;
41 | 		ReGaItem it=ReGaDeviceCache.getItemByName(name);
42 | 		if(it!=null)
43 | 		{
44 | 			//System.out.println(name +" -> "+it.address);
45 | 			return it.address;
46 | 		}
47 | 		else
48 | 		{
49 | 			HMC.l.warning("Unable to resolve name "+name);
50 | 			return name;
51 | 		}
52 | 	}
53 | 
54 | 	String cmd;
55 | 	String desc;
56 | 
57 | 	ServerCommand(String cmd,String desc)
58 | 	{
59 | 		this.cmd=cmd;
60 | 		this.desc=desc;
61 | 	}
62 | 
63 | 	public abstract void exec(Server s,ArgSplitter args) throws Exception;
64 | }
65 | 


--------------------------------------------------------------------------------
/src/com/vapor/hmcompanion/ui/DevRSSIModel.java:
--------------------------------------------------------------------------------
 1 | package com.vapor.hmcompanion.ui;
 2 | 
 3 | import javax.swing.table.*;
 4 | 
 5 | @SuppressWarnings("serial")
 6 | public class DevRSSIModel extends AbstractTableModel
 7 | {
 8 | 	public int getColumnCount()
 9 | 	{
10 | 		return 1+BidcosInterface.interfaces.size()+1;
11 | 	}
12 | 
13 | 	public int getRowCount()
14 | 	{
15 | 		return Device.deviceList.size();
16 | 	}
17 | 
18 | 	public Object getValueAt(int row, int col)
19 | 	{
20 | 		Device d=Device.deviceList.get(row);
21 | 
22 | 		if(col==0)
23 | 			return d.makeLabel();
24 | 		else if(col>=1 && col<=BidcosInterface.interfaces.size())
25 | 			return d.ifrssi[col-1];
26 | 		else if(col==1+BidcosInterface.interfaces.size())
27 | 			return d.roaming;
28 | 		else
29 | 			return "?";
30 | 	}
31 | 
32 | 	@Override
33 | 	public String getColumnName(int col)
34 | 	{
35 | 		if(col==0)
36 | 			return "Device";
37 | 		else if(col>=1 && col<=BidcosInterface.interfaces.size())
38 | 		{
39 | 			BidcosInterface i=BidcosInterface.interfaceList.get(col-1);
40 | 
41 | 			if(i.description!=null)
42 | 				return "IF:"+i.description+" ("+i.address+")";
43 | 
44 | 			return "IF:"+i.address;
45 | 		}
46 | 		else if(col==BidcosInterface.interfaces.size()+1)
47 | 			return "Roaming?";
48 | 		else
49 | 			return "?";
50 | 	}
51 | 
52 | 	@Override
53 | 	public Class<?> getColumnClass(int col)
54 | 	{
55 | 		if(col>=1 && col<BidcosInterface.interfaces.size())
56 | 		{
57 | 			return RSSI.RSSIInfo.class;
58 | 		}
59 | 		else if(col==1+BidcosInterface.interfaces.size())
60 | 			return Boolean.class;
61 | 		return String.class;
62 | 	}
63 | 
64 | 	@Override
65 | 	public boolean isCellEditable(int row, int col)
66 | 	{
67 | 		return col>=1 && col<=1+BidcosInterface.interfaces.size();
68 | 	}
69 | 
70 | 	@Override
71 | 	public void setValueAt(Object val, int row, int col)
72 | 	{
73 | 		Device d=Device.deviceList.get(row);
74 | 
75 | 		if(col==1+BidcosInterface.interfaces.size())
76 | 			d.setRoaming((Boolean)val);
77 | 		if(col>=1&&col<1+BidcosInterface.interfaces.size())
78 | 		{
79 | 			d.setInterface(BidcosInterface.interfaceList.get(col-1).address);
80 | 			fireTableRowsUpdated(row,row);
81 | 		}
82 | 	}
83 | 
84 | }
85 | 


--------------------------------------------------------------------------------
/src/com/vapor/hmcompanion/AttributeCache.java:
--------------------------------------------------------------------------------
 1 | /*
 2 |  * Caches received attributes
 3 |  */
 4 | 
 5 | package com.vapor.hmcompanion;
 6 | 
 7 | import java.io.*;
 8 | import java.util.*;
 9 | import java.util.logging.*;
10 | 
11 | public class AttributeCache
12 | {
13 | 	static Map<String,Map<String,Attribute>> attrCache=new HashMap<String,Map<String,Attribute>>();
14 | 
15 | 	static synchronized void putAttribute(String device,String attr,Object value)
16 | 	{
17 | 		Map<String,Attribute> dev=attrCache.get(device);
18 | 		if(dev==null)
19 | 		{
20 | 			dev=new HashMap<String,Attribute>();
21 | 			attrCache.put(device.intern(),dev);
22 | 		}
23 | 		Attribute a=dev.get(attr);
24 | 		if(a==null)
25 | 		{
26 | 			a=new Attribute();
27 | 			dev.put(attr.intern(),a);
28 | 		}
29 | 		a.set(value);
30 | 	}
31 | 	static public synchronized Attribute getAttribute(String device,String attr)
32 | 	{
33 | 		Map<String,Attribute> dev=attrCache.get(device);
34 | 		if(dev==null)
35 | 			return null;
36 | 		return dev.get(attr);
37 | 	}
38 | 	static synchronized Map<String,Attribute> getAllAttributes(String device)
39 | 	{
40 | 		Map<String,Attribute> dev=attrCache.get(device);
41 | 		return dev;
42 | 	}
43 | 
44 | 	@SuppressWarnings("unchecked")
45 | 	static void load()
46 | 	{
47 | 		try
48 | 		{
49 | 			ObjectInputStream ois=new ObjectInputStream(new FileInputStream("hmc.cache"));
50 | 			attrCache=(Map<String,Map<String,Attribute>>)ois.readObject();
51 | 			ois.close();
52 | 			HMC.l.info("Read "+attrCache.size()+" entries from hmc.cache");
53 | 		}
54 | 		catch(FileNotFoundException fnfe)
55 | 		{
56 | 			/* Ignore, can happen */
57 | 		}
58 | 		catch(Exception e)
59 | 		{
60 | 			HMC.l.log(Level.WARNING,"Unable to load attribute cache",e);
61 | 		}
62 | 		Runtime.getRuntime().addShutdownHook(new Saver());
63 | 	}
64 | 
65 | 	static class Saver extends Thread
66 | 	{
67 | 		@Override
68 | 		public void run()
69 | 		{
70 | 			try
71 | 			{
72 | 				ObjectOutputStream oos=new ObjectOutputStream(new FileOutputStream("hmc.cache"));
73 | 				oos.writeObject(attrCache);
74 | 				oos.close();
75 | 			}
76 | 			catch(Exception e)
77 | 			{
78 | 				HMC.l.log(Level.WARNING,"Unable to write attribute cache",e);
79 | 			}
80 | 		}
81 | 	}
82 | 
83 | }
84 | 


--------------------------------------------------------------------------------
/src/com/vapor/hmcompanion/HMXRConnection.java:
--------------------------------------------------------------------------------
 1 | /*
 2 |  * Handles a outgoing "XML-RPC" connection with the binary encoded CCU format
 3 |  */
 4 | 
 5 | package com.vapor.hmcompanion;
 6 | 
 7 | import java.io.IOException;
 8 | import java.net.*;
 9 | import java.text.ParseException;
10 | import java.util.logging.*;
11 | 
12 | public class HMXRConnection extends Thread
13 | {
14 | 	Socket s;
15 | 	String host;
16 | 	int port;
17 | 	String serverurl;
18 | 	int instance;
19 | 
20 | 	public HMXRConnection(String host,int port,String serverurl,int instance)
21 | 	{
22 | 		this.host=host;
23 | 		this.port=port;
24 | 		this.serverurl=serverurl;
25 | 		this.instance=instance;
26 | 	}
27 | 
28 | 	// Deinit on shutdown
29 | 	private class Deiniter extends Thread
30 | 	{
31 | 		@Override
32 | 		public void run()
33 | 		{
34 | 			try
35 | 			{
36 | 				HMXRMsg m=new HMXRMsg("init");
37 | 				m.addArg(serverurl);
38 | 				sendRequest(m,false);
39 | 			}
40 | 			catch(Exception e)
41 | 			{
42 | 				/* Ignore, we're dying anyway */
43 | 			}
44 | 		}
45 | 	}
46 | 
47 | 	public void sendInit()
48 | 	{
49 | 		HMC.l.info("Sending init to "+host+":"+port+" with "+serverurl);
50 | 		HMXRMsg m=new HMXRMsg("init");
51 | 		m.addArg(serverurl);
52 | 		m.addArg("CB"+instance);
53 | 		try
54 | 		{
55 | 			sendRequest(m,false);
56 | 			HMC.l.info("Init to "+host+":"+port+" with "+serverurl+" successful");
57 | 		}
58 | 		catch(Exception e)
59 | 		{
60 | 			/* Ignore */
61 | 		}
62 | 		// Queue a deinit on shutdown
63 | 		Runtime.getRuntime().addShutdownHook(new Deiniter());
64 | 	}
65 | 
66 | 
67 | 	public synchronized HMXRResponse sendRequest(HMXRMsg m,boolean retry) throws IOException, ParseException
68 | 	{
69 | 		try
70 | 		{
71 | 			if(s==null)
72 | 				s=new Socket(host,port);
73 | 
74 | 			s.getOutputStream().write(m.prepareData());
75 | 			return HMXRResponse.readMsg(s,false);
76 | 		}
77 | 		catch(IOException ioe)
78 | 		{
79 | 			if(!retry)
80 | 				throw ioe; // Just rethrow
81 | 			HMC.l.log(Level.WARNING,"Error during transaction handling",ioe);
82 | 			try
83 | 			{
84 | 				sleep(30000);
85 | 			}
86 | 			catch(InterruptedException ie)
87 | 			{
88 | 				/* Ignore */
89 | 			}
90 | 			s=null;
91 | 			return sendRequest(m,true);
92 | 		}
93 | 	}
94 | 	public HMXRResponse sendRequest(HMXRMsg m) throws IOException, ParseException
95 | 	{
96 | 		return sendRequest(m,true);
97 | 	}
98 | }
99 | 


--------------------------------------------------------------------------------
/src/com/vapor/hmcompanion/GraphiteInterface.java:
--------------------------------------------------------------------------------
 1 | package com.vapor.hmcompanion;
 2 | 
 3 | import java.net.*;
 4 | import java.util.logging.*;
 5 | 
 6 | public class GraphiteInterface
 7 | {
 8 | 	private static String carbon_host;
 9 | 	private static String carbon_prefix;
10 | 	private static int carbon_port;
11 | 
12 | 	public static void init()
13 | 	{
14 | 		String carbonHost=System.getProperty("hmc.carbon.host");
15 | 		if(carbonHost==null)
16 | 			return;
17 | 		String cbp[]=carbonHost.split(":",2);
18 | 		carbon_host=cbp[0];
19 | 		if(cbp.length==2)
20 | 			carbon_port=Integer.parseInt(cbp[1]);
21 | 		else
22 | 			carbon_port=2003;
23 | 
24 | 		carbon_prefix=System.getProperty("hmc.carbon.prefix","hm.");
25 | 		if(!carbon_prefix.endsWith("."))
26 | 			carbon_prefix+=".";
27 | 
28 | 		HMC.l.info("Using graphite/carbon server "+carbon_host+":"+carbon_port+" with metric prefix \""+carbon_prefix+"\"");
29 | 	}
30 | 
31 | 	private static String sanitizeName(String name)
32 | 	{
33 | 		name=name.toLowerCase();
34 | 		name=name.replace("ä","ae");
35 | 		name=name.replace("ö","oe");
36 | 		name=name.replace("ü","ue");
37 | 		name=name.replace("ß","ss");
38 | 		StringBuilder nn=new StringBuilder(name);
39 | 		for(int ix=0;ix<nn.length();ix++)
40 | 		{
41 | 			char ch=nn.charAt(ix);
42 | 			if(	!(ch>='a'&&ch<='z') && !(ch>='0'&&ch<='9'))
43 | 			{
44 | 				nn.setCharAt(ix, '_');
45 | 			}
46 | 		}
47 | 		return nn.toString();
48 | 	}
49 | 
50 | 	public static void sendToCarbon(String address,String item,String val)
51 | 	{
52 | 		if(carbon_host==null)
53 | 			return;
54 | 
55 | 		ReGaItem rit=ReGaDeviceCache.getItemByName(address);
56 | 		if(rit==null)
57 | 			return;
58 | 
59 | 		// Transform value
60 | 		String saneValue=val;
61 | 		try
62 | 		{
63 | 			Double.parseDouble(val);
64 | 		}
65 | 		catch(NumberFormatException nfe)
66 | 		{
67 | 			val=Boolean.parseBoolean(val)?"1":"0";
68 | 		}
69 | 
70 | 		// Transform name -- everything which isn't good as a metric char is transformed to "_"
71 | 		StringBuilder msg=new StringBuilder(carbon_prefix);
72 | 		msg.append(sanitizeName(rit.name));
73 | 		msg.append('.');
74 | 		msg.append(sanitizeName(item));
75 | 		msg.append(' ');
76 | 		msg.append(saneValue);
77 | 		msg.append(' ');
78 | 		msg.append(System.currentTimeMillis()/1000);
79 | 		msg.append('\n');
80 | 
81 | 		try
82 | 		{
83 | 			Socket s=new Socket(carbon_host,carbon_port);
84 | 			s.getOutputStream().write(msg.toString().getBytes("ASCII"));
85 | 			s.getOutputStream().flush();
86 | 			s.close();
87 | 		}
88 | 		catch(Exception e)
89 | 		{
90 | 			HMC.l.log(Level.WARNING,"Unable to send data to carbon host",e);
91 | 		}
92 | 	}
93 | }
94 | 


--------------------------------------------------------------------------------
/src/com/vapor/hmcompanion/Server.java:
--------------------------------------------------------------------------------
  1 | /*
  2 |  * This is the client-side server process, used for sending commands to HMCompanion.
  3 |  *
  4 |  * Use a simple line-based protocol suitable for use with netcat or PHP
  5 |  */
  6 | 
  7 | package com.vapor.hmcompanion;
  8 | 
  9 | import java.io.*;
 10 | import java.net.*;
 11 | import java.util.logging.*;
 12 | 
 13 | public class Server extends Thread
 14 | {
 15 | 	private static ServerSocket ss;
 16 | 	private static String authkey;
 17 | 	public static void acceptIt(int port,String authkey) throws IOException
 18 | 	{
 19 | 		Server.authkey=authkey;
 20 | 		ServerCommand.initCommands();
 21 | 		ss=new ServerSocket();
 22 | 		ss.setReuseAddress(true);
 23 | 		ss.bind(new InetSocketAddress(port));
 24 | 		HMC.l.info("Accepting connections on "+ss);
 25 | 		for(;;)
 26 | 		{
 27 | 			Socket s=ss.accept();
 28 | 			new Server(s).start();
 29 | 		}
 30 | 	}
 31 | 
 32 | 	Socket s;
 33 | 	PrintWriter pw;
 34 | 	Server(Socket s)
 35 | 	{
 36 | 		super("Handler for "+s);
 37 | 		this.s=s;
 38 | 	}
 39 | 
 40 | 	void send(String txt)
 41 | 	{
 42 | 		pw.println(txt);
 43 | 	}
 44 | 
 45 | 	private void handleCommand(String l) throws Exception
 46 | 	{
 47 | 		String cmdparts[]=l.split(" ",2);
 48 | 		String cmd=cmdparts[0].toUpperCase();
 49 | 
 50 | 		ServerCommand sc=ServerCommand.get(cmd);
 51 | 		if(sc!=null)
 52 | 		{
 53 | 			sc.exec(this,new ArgSplitter(cmdparts.length>1?cmdparts[1]:""));
 54 | 		}
 55 | 		else
 56 | 			pw.println("-Unknown command "+cmd);
 57 | 	}
 58 | 
 59 | 	@Override
 60 | 	public void run()
 61 | 	{
 62 | 		HMC.l.info("Accepted connection from "+s.getRemoteSocketAddress());
 63 | 		try
 64 | 		{
 65 | 			// Active TCP keepalive
 66 | 			s.setKeepAlive(true);
 67 | 			BufferedReader br=new BufferedReader(new InputStreamReader(s.getInputStream(),"UTF-8"));
 68 | 			pw=new PrintWriter(s.getOutputStream());
 69 | 			String l;
 70 | 
 71 | 			if(authkey!=null)
 72 | 			{
 73 | 				// Require Authentication first
 74 | 				l=br.readLine();
 75 | 				if(!l.equals("AUTH "+authkey))
 76 | 				{
 77 | 					pw.println("-AUTH failed");
 78 | 					pw.flush();
 79 | 					HMC.l.log(Level.WARNING,"Authentication failed: "+l+" expecting: AUTH "+authkey);
 80 | 					return;
 81 | 				}
 82 | 			}
 83 | 
 84 | 			while((l=br.readLine())!=null)
 85 | 			{
 86 | 				handleCommand(l);
 87 | 				pw.flush();
 88 | 			}
 89 | 		}
 90 | 		catch(EOFException eof)
 91 | 		{
 92 | 			/* Don't log */
 93 | 		}
 94 | 		catch(Exception e)
 95 | 		{
 96 | 			pw.println("-INTERNAL ERROR");
 97 | 			pw.flush();
 98 | 			HMC.l.log(Level.FINE,"Closing connection",e);
 99 | 		}
100 | 		finally
101 | 		{
102 | 			try
103 | 			{
104 | 				s.close();
105 | 			}
106 | 			catch(Exception e)
107 | 			{
108 | 				// We don't care here
109 | 			}
110 | 		}
111 | 	}
112 | }
113 | 


--------------------------------------------------------------------------------
/src/com/vapor/hmcompanion/ReGaDeviceCache.java:
--------------------------------------------------------------------------------
  1 | /*
  2 |  * Caches ReGa channel names
  3 |  */
  4 | 
  5 | package com.vapor.hmcompanion;
  6 | 
  7 | import java.util.*;
  8 | import java.util.regex.*;
  9 | 
 10 | public class ReGaDeviceCache
 11 | {
 12 | 	static Map<String,ReGaItem> itemsByName=new HashMap<String,ReGaItem>();
 13 | 	static Map<String,ReGaItem> itemsByAddress=new HashMap<String,ReGaItem>();
 14 | 
 15 | 	static ReGaItem getItemByName(String name)
 16 | 	{
 17 | 		ReGaItem it=itemsByName.get(name);
 18 | 		if(it==null)
 19 | 			it=itemsByAddress.get(name);
 20 | 		return it;
 21 | 	}
 22 | 
 23 | 	static Collection<ReGaItem> getItemsByName(String name)
 24 | 	{
 25 | 		if(name.indexOf("*")<0)
 26 | 		{
 27 | 			ReGaItem it=getItemByName(name);
 28 | 			if(it!=null)
 29 | 				return Collections.singleton(it);
 30 | 			else
 31 | 				return null;
 32 | 		}
 33 | 
 34 | 		Set<ReGaItem> res=new HashSet<ReGaItem>();
 35 | 		String wname=name.replace("*",".*");
 36 | 		Pattern p=Pattern.compile(wname);
 37 | 		for(String k:itemsByName.keySet())
 38 | 		{
 39 | 			if(p.matcher(k).matches())
 40 | 				res.add(itemsByName.get(k));
 41 | 		}
 42 | 		for(String k:itemsByAddress.keySet())
 43 | 		{
 44 | 			if(p.matcher(k).matches())
 45 | 				res.add(itemsByName.get(k));
 46 | 		}
 47 | 		return res;
 48 | 	}
 49 | 
 50 | 	static private void putRegaItem(String id,String address,String interf,String name)
 51 | 	{
 52 | 		ReGaItem r=new ReGaItem(Integer.parseInt(id),name,address,interf);
 53 | 		itemsByName.put(name,r);
 54 | 		itemsByAddress.put(address,r);
 55 | 	}
 56 | 
 57 | 	/*
 58 | 	 * Obtain the High Level Device IDs
 59 | 	 */
 60 | 	static public void loadDeviceCache()
 61 | 	{
 62 | 		HMC.l.info("Obtaining ReGa channel items");
 63 | 		String r=TCLRegaHandler.sendHMScript(
 64 | 			"string id;"+
 65 | 			"foreach(id, root.Channels().EnumUsedIDs())"+
 66 | 			"  {"+
 67 | 			"   var ch=dom.GetObject(id);" +
 68 | 			"	var i=dom.GetObject(ch.Interface());"+
 69 | 			"   WriteLine(id+\"\t\"+ch.Address()+\"\t\"+i.Name()+\"\t\"+ch.Name());"+
 70 | 			"  }"
 71 | 		);
 72 | 		if(r==null)
 73 | 		{
 74 | 			// Request failed, refuse to run
 75 | 			System.exit(1);
 76 | 		}
 77 | 		String lines[]=r.split("\n");
 78 | 		for(String l:lines)
 79 | 		{
 80 | 			String p[]=l.split("\t");
 81 | 			if(p.length==4)
 82 | 				putRegaItem(p[0],p[1],p[2],p[3]);
 83 | 		}
 84 | 		HMC.l.info("Obtained "+itemsByName.size()+" ReGa Channel items");
 85 | 	}
 86 | 
 87 | 	static public Map<String,String> loadDeviceNames()
 88 | 	{
 89 | 		Map<String,String> m=new TreeMap<String,String>();
 90 | 
 91 | 		HMC.l.info("Obtaining ReGa device names");
 92 | 		String r=TCLRegaHandler.sendHMScript(
 93 | 			"string id;"+
 94 | 			"foreach(id, root.Devices().EnumUsedIDs())"+
 95 | 			"  {"+
 96 | 			"   var d=dom.GetObject(id);" +
 97 | 			"   WriteLine(d.Address()+\"\t\"+d.Name());"+
 98 | 			"  }" +
 99 | 			"foreach(id, root.Channels().EnumUsedIDs())"+
100 | 			"  {"+
101 | 			"   var d=dom.GetObject(id);" +
102 | 			"   WriteLine(d.Address()+\"\t\"+d.Name());"+
103 | 			"  }"
104 | 		);
105 | 		if(r==null)
106 | 		{
107 | 			return m;
108 | 		}
109 | 		String lines[]=r.split("\n");
110 | 		for(String l:lines)
111 | 		{
112 | 			String p[]=l.split("\t",2);
113 | 			if(p.length==2)
114 | 				m.put(p[0],p[1]);
115 | 		}
116 | 		HMC.l.info("Obtained "+m.size()+" ReGa device names");
117 | 		return m;
118 | 	}
119 | }
120 | 


--------------------------------------------------------------------------------
/src/com/vapor/hmcompanion/ui/RSSIRenderer.java:
--------------------------------------------------------------------------------
  1 | package com.vapor.hmcompanion.ui;
  2 | 
  3 | import java.awt.*;
  4 | import java.awt.event.*;
  5 | import java.util.EventObject;
  6 | 
  7 | import javax.swing.*;
  8 | import javax.swing.table.DefaultTableCellRenderer;
  9 | import javax.swing.table.TableCellEditor;
 10 | 
 11 | @SuppressWarnings("serial")
 12 | public class RSSIRenderer extends DefaultTableCellRenderer
 13 | {
 14 | 	JCheckBox cb_def=new JCheckBox("Default?");
 15 | 	JLabel lab_from,lab_to;
 16 | 
 17 | 	JPanel pan;
 18 | 
 19 | 	public class RSSIEditor extends AbstractCellEditor implements TableCellEditor
 20 | 	{
 21 | 		RSSIRenderer r;
 22 | 
 23 | 		@Override
 24 | 		public boolean isCellEditable(EventObject arg0)
 25 | 		{
 26 | 			return true;
 27 | 		}
 28 | 
 29 | 		public Component getTableCellEditorComponent(JTable table, Object value, boolean isSelected, int row, int column)
 30 | 		{
 31 | 			r=new RSSIRenderer();
 32 | 			r.cb_def.addActionListener(new ActionListener(){
 33 | 				public void actionPerformed(ActionEvent arg0)
 34 | 				{
 35 | 					SwingUtilities.invokeLater(new Runnable(){
 36 | 						public void run()
 37 | 						{
 38 | 							stopCellEditing();
 39 | 						}
 40 | 					});
 41 | 				}
 42 | 			});
 43 | 			return r.getTableCellRendererComponent(table, value, isSelected, true, row, column);
 44 | 		}
 45 | 
 46 | 		@SuppressWarnings("boxing")
 47 | 		public Object getCellEditorValue()
 48 | 		{
 49 | 			return r.cb_def.isSelected();
 50 | 		}
 51 | 	}
 52 | 
 53 | 	RSSIEditor editor=new RSSIEditor();
 54 | 
 55 | 	public RSSIRenderer()
 56 | 	{
 57 | 		pan=new JPanel(new BorderLayout());
 58 | 
 59 | 		JPanel pan_lab=new JPanel(new GridLayout(1,2, 2,0));
 60 | 
 61 | 		lab_from=new JLabel("-");
 62 | 		lab_from.setOpaque(true);
 63 | 		lab_from.setBorder(BorderFactory.createEmptyBorder(2,2,2,2));
 64 | 
 65 | 		lab_to=new JLabel("-");
 66 | 		lab_to.setOpaque(true);
 67 | 		lab_to.setBorder(BorderFactory.createEmptyBorder(2,2,2,2));
 68 | 		lab_to.setHorizontalTextPosition(RIGHT);
 69 | 
 70 | 		pan_lab.add(lab_from);
 71 | 		pan_lab.add(lab_to);
 72 | 
 73 | 		pan.add(cb_def,BorderLayout.NORTH);
 74 | 		pan.add(pan_lab,BorderLayout.CENTER);
 75 | 
 76 | 	}
 77 | 
 78 | 	private int rssic(int rssi,int lower_bound,int upper_bound)
 79 | 	{
 80 | 		int result=256*(rssi-lower_bound)/(upper_bound-lower_bound);
 81 | 		if(result<0)
 82 | 			return 0;
 83 | 		else if(result>255)
 84 | 			return 255;
 85 | 		else
 86 | 			return result;
 87 | 	}
 88 | 
 89 | 	private void setBGColor(JLabel l,int v)
 90 | 	{
 91 | 		if(v==65536)
 92 | 		{
 93 | 			l.setBackground(new Color(220,220,220));
 94 | 			l.setText(" ");
 95 | 			return;
 96 | 		}
 97 | 
 98 | 		l.setText(v+"dBm");
 99 | 
100 | 		l.setBackground(new Color(
101 | 			rssic(v,-20,-100),
102 | 			rssic(v,-120,-80),
103 | 		0));
104 | 	}
105 | 	@Override
106 | 	public Component getTableCellRendererComponent(JTable table, Object value, boolean isSelected, boolean hasFocus, int row, int column)
107 | 	{
108 | 		RSSI.RSSIInfo ri=(RSSI.RSSIInfo)value;
109 | 
110 | 		cb_def.setSelected(ri.isDef);
111 | 
112 | 		setBGColor(lab_from,ri.from);
113 | 		setBGColor(lab_to,ri.to);
114 | 
115 | 
116 | 		if(ri.isBest)
117 | 			cb_def.setBackground(new Color(230,255,230));
118 | 		else if(ri.isWrong)
119 | 			cb_def.setBackground(new Color(255,230,230));
120 | 		else
121 | 			cb_def.setBackground(Color.white);
122 | 
123 | 		return pan;
124 | 	}
125 | }
126 | 


--------------------------------------------------------------------------------
/src/com/vapor/hmcompanion/HMC.java:
--------------------------------------------------------------------------------
  1 | /*
  2 |  * HomeMatic Companion
  3 |  * -------------------
  4 |  *
  5 |  * Simple server which provides utility functions for dealing with a HomeMatic CCU for
  6 |  * integration into a broader home automation environment.
  7 |  *
  8 |  * Written by Oliver Wagner <owagner@vapor.com>
  9 |  */
 10 | 
 11 | package com.vapor.hmcompanion;
 12 | 
 13 | import java.io.*;
 14 | import java.net.*;
 15 | import java.util.*;
 16 | import java.util.logging.*;
 17 | 
 18 | import com.vapor.hmcompanion.ui.*;
 19 | 
 20 | public class HMC
 21 | {
 22 | 	static HMXRConnection connections[];
 23 | 	static public Logger l;
 24 | 	static public String version="0.22";
 25 | 	static public Timer t=new Timer(true);
 26 | 
 27 | 	static void reInit()
 28 | 	{
 29 | 		for(HMXRConnection c:connections)
 30 | 			c.sendInit();
 31 | 	}
 32 | 
 33 | 	protected static void initWatchog()
 34 | 	{
 35 | 		long now=System.currentTimeMillis();
 36 | 		// If we didn't get a message for more than 60s, reinit
 37 | 		if(now-XMLRPCServer.lastRequest>(3*60*1000))
 38 | 		{
 39 | 			l.warning("No XML-RPC request since "+new Date(XMLRPCServer.lastRequest)+", reiniting");
 40 | 			reInit();
 41 | 		}
 42 | 	}
 43 | 
 44 | 	private static void serverMode(String hmhost,int port,String authkey) throws Exception
 45 | 	{
 46 | 		l=Logger.getLogger("hmcompanion");
 47 | 		l.info("HMCompanion V"+version+" (C) 2013 Oliver Wagner <owagner@vapor.com>, All Rights Reserved");
 48 | 		AttributeCache.load();
 49 | 		GraphiteInterface.init();
 50 | 		TCLRegaHandler.setHMHost(hmhost);
 51 | 		String serverurl=XMLRPCServer.init();
 52 | 		l.info("Listening for XMLRPC callbacks on "+serverurl+", now init-ing");
 53 | 		boolean useCUXD=false;
 54 | 		try
 55 | 		{
 56 | 			Socket s=new Socket(hmhost,8701);
 57 | 			s.close();
 58 | 			useCUXD=true;
 59 | 		}
 60 | 		catch(Exception e)
 61 | 		{
 62 | 			// Ignore
 63 | 			l.fine("Probing for CUxD failed, deactivating");
 64 | 		}
 65 | 
 66 | 		connections=new HMXRConnection[useCUXD?4:3];
 67 | 		for(int c=0;c<3;c++)
 68 | 		{
 69 | 			connections[c]=new HMXRConnection(hmhost,2000+c,serverurl,c);
 70 | 		}
 71 | 		if(useCUXD)
 72 | 			connections[3]=new HMXRConnection(hmhost,8701,serverurl,3);
 73 | 		reInit();
 74 | 		t.schedule(new TimerTask(){
 75 | 			@Override
 76 | 			public void run()
 77 | 			{
 78 | 				initWatchog();
 79 | 			}
 80 | 		},30*1000,30*1000);
 81 | 		ReGaDeviceCache.loadDeviceCache();
 82 | 		Server.acceptIt(port,authkey);
 83 | 	}
 84 | 
 85 | 	private static void loadProperties() throws IOException
 86 | 	{
 87 | 		File f=new File("hmcompanion.cfg");
 88 | 		if(f.exists())
 89 | 		{
 90 | 			BufferedReader br=new BufferedReader(new FileReader(f));
 91 | 			String l;
 92 | 			while((l=br.readLine())!=null)
 93 | 			{
 94 | 				String p[]=l.split("=",2);
 95 | 				if(p.length==2)
 96 | 					System.setProperty(p[0],p[1]);
 97 | 			}
 98 | 			br.close();
 99 | 		}
100 | 	}
101 | 
102 | 	public static void main(String args[]) throws Exception
103 | 	{
104 | 		l=Logger.getLogger("hmc");
105 | 
106 | 		loadProperties();
107 | 
108 | 		if(args.length>=2 && "-server".equals(args[1]))
109 | 		{
110 | 			serverMode(args[0],args.length>2?Integer.parseInt(args[2]):6770,args.length>3?args[3]:null);
111 | 		}
112 | 		else if(args.length<3)
113 | 		{
114 | 			// UI Mode
115 | 			MainWin.launchUI(args.length>0?args[0]:null, args.length>1?args[1]:null);
116 | 		}
117 | 		else
118 | 		{
119 | 			HMXRConnection conn=new HMXRConnection(args[0],Integer.parseInt(args[1]),null,-1);
120 | 			HMXRMsg m=new HMXRMsg(args[2]);
121 | 			for(int ix=3;ix<args.length;ix++)
122 | 				m.addArg(args[ix]);
123 | 			HMXRResponse r=conn.sendRequest(m);
124 | 			System.out.println(r);
125 | 		}
126 | 	}
127 | }
128 | 


--------------------------------------------------------------------------------
/src/com/vapor/hmcompanion/ui/DevicePopupMenu.java:
--------------------------------------------------------------------------------
  1 | package com.vapor.hmcompanion.ui;
  2 | 
  3 | import java.awt.event.*;
  4 | import java.util.*;
  5 | 
  6 | import javax.swing.*;
  7 | 
  8 | import com.vapor.hmcompanion.*;
  9 | 
 10 | public class DevicePopupMenu extends JPopupMenu
 11 | {
 12 | 	public DevicePopupMenu(Device d)
 13 | 	{
 14 | 		super();
 15 | 
 16 | 		addEntries(d,d.getValueParamsetDescription());
 17 | 		for(Device sd:d.subdevices.values())
 18 | 		{
 19 | 			addEntries(sd,sd.getValueParamsetDescription());
 20 | 		}
 21 | 	}
 22 | 
 23 | 	private void addSetter(final JMenuItem mit,final Device d,final String n,final Object val)
 24 | 	{
 25 | 		mit.addActionListener(new ActionListener(){
 26 | 			@SuppressWarnings("boxing")
 27 | 			public void actionPerformed(ActionEvent e)
 28 | 			{
 29 | 				if(val==null)
 30 | 				{
 31 | 					// Checkbox or action
 32 | 					if(mit instanceof JCheckBoxMenuItem)
 33 | 					{
 34 | 						Boolean sel=mit.isSelected();
 35 | 						d.setValue(n,sel);
 36 | 					}
 37 | 					else
 38 | 						d.setValue(n,Boolean.TRUE);
 39 | 				}
 40 | 				else
 41 | 				{
 42 | 					d.setValue(n,val);
 43 | 				}
 44 | 			}
 45 | 		});
 46 | 	}
 47 | 
 48 | 	private void addEntries(Device d,HMXRMap v)
 49 | 	{
 50 | 		HMXRMap vals=d.getValues();
 51 | 
 52 | 		if(v.getString("faultString")!=null)
 53 | 			return;
 54 | 
 55 | 		JMenu m=new JMenu(d.getName());
 56 | 		boolean didAdd=false;
 57 | System.out.println(v);
 58 | 		for(Map.Entry<String,Object> e:v.entrySet())
 59 | 		{
 60 | 			String lab=e.getKey();
 61 | 			HMXRMap parms=(HMXRMap)e.getValue();
 62 | 			String type=parms.getString("TYPE");
 63 | 			int ops=parms.getInt("OPERATIONS");
 64 | 			if((ops&2)!=0)
 65 | 			{
 66 | 				// Ok this parameter is settable
 67 | 				if("BOOL".equals(type))
 68 | 				{
 69 | 					JCheckBoxMenuItem mit=new JCheckBoxMenuItem(lab);
 70 | 					mit.setSelected(vals.getBool(lab));
 71 | 					addSetter(mit,d,lab,null);
 72 | 					m.add(mit);
 73 | 					didAdd=true;
 74 | 				}
 75 | 				else if("ACTION".equals(type))
 76 | 				{
 77 | 					JMenuItem mit=new JMenuItem("\u21D2"+lab);
 78 | 					addSetter(mit,d,lab,null);
 79 | 					m.add(mit);
 80 | 					didAdd=true;
 81 | 				}
 82 | 				else if("FLOAT".equals(type))
 83 | 				{
 84 | 					String unit=parms.getString("UNIT");
 85 | 
 86 | 					if("100%".equals(unit))
 87 | 					{
 88 | 						JMenu mg=new JMenu(lab+" "+Math.round(vals.getDouble(lab)*100)+"%");
 89 | 						for(int c=0;c<10;c++)
 90 | 						{
 91 | 							JMenuItem mit=new JMenuItem((c*10)+"%");
 92 | 							addSetter(mit,d,lab,new Double(c/10.0));
 93 | 							mg.add(mit);
 94 | 						}
 95 | 						m.add(mg);
 96 | 						didAdd=true;
 97 | 					}
 98 | 					else
 99 | 					{
100 | 
101 | 						JMenu mg=new JMenu(lab+" "+vals.get(lab));
102 | 						double min=parms.getDouble("MIN");
103 | 						double max=parms.getDouble("MAX");
104 | 
105 | 						for(int c=0;c<10;c++)
106 | 						{
107 | 							double sv=min + ((max-min)/10)*c;
108 | 
109 | 							JMenuItem mit=new JMenuItem(String.valueOf(sv));
110 | 							mg.add(mit);
111 | 						}
112 | 						m.add(mg);
113 | 						didAdd=true;
114 | 					}
115 | 				}
116 | 			}
117 | 			else
118 | 			{
119 | 				// Display only
120 | 				Object vlab=vals.get(lab);
121 | 
122 | 				if("ENUM".equals(type))
123 | 				{
124 | 					List<?> vl=(List<?>)parms.get("VALUE_LIST");
125 | 					if(vl!=null)
126 | 						vlab=vl.get(vals.getInt(lab));
127 | 				}
128 | 
129 | 				String unit=parms.getString("UNIT");
130 | 				unit=unit.replace("&#176;","o");
131 | 				if(unit==null || unit.length()==0)
132 | 					unit="";
133 | 
134 | 				JMenuItem mit=new JMenuItem(lab+": "+vlab+unit);
135 | 				mit.setEnabled(false);
136 | 				m.add(mit);
137 | 				didAdd=true;
138 | 			}
139 | 		}
140 | 
141 | 		if(didAdd)
142 | 			add(m);
143 | 	}
144 | }
145 | 


--------------------------------------------------------------------------------
/src/com/vapor/hmcompanion/HMXRMsg.java:
--------------------------------------------------------------------------------
  1 | /*
  2 |  * A HomeMatic "XML-RPC" message (outgoing)
  3 |  */
  4 | 
  5 | package com.vapor.hmcompanion;
  6 | 
  7 | import java.io.UnsupportedEncodingException;
  8 | import java.math.BigInteger;
  9 | import java.util.*;
 10 | 
 11 | public class HMXRMsg
 12 | {
 13 | 	private byte data[];
 14 | 	private int dataoffset;
 15 | 
 16 | 	private void addByte(byte b)
 17 | 	{
 18 | 		if(dataoffset==data.length)
 19 | 		{
 20 | 			byte newdata[]=new byte[data.length*2];
 21 | 			System.arraycopy(data,0,newdata,0,data.length);
 22 | 			data=newdata;
 23 | 		}
 24 | 		data[dataoffset++]=b;
 25 | 	}
 26 | 	private void addInt(int n)
 27 | 	{
 28 | 		byte d[]=BigInteger.valueOf(n).toByteArray();
 29 | 		for(int c=0;c<4-d.length;c++)
 30 | 			addByte((byte)0);
 31 | 		for(byte s:d)
 32 | 			addByte(s);
 33 | 
 34 | 	}
 35 | 	private void addString(String s)
 36 | 	{
 37 | 		byte sd[];
 38 | 		try
 39 | 		{
 40 | 			sd=s.getBytes("ISO-8859-1");
 41 | 		}
 42 | 		catch(UnsupportedEncodingException use)
 43 | 		{
 44 | 			// Really shouldn't happen, fall back silently to platform encoding
 45 | 			sd=s.getBytes();
 46 | 		}
 47 | 		for(byte ch:sd)
 48 | 			addByte(ch);
 49 | 	}
 50 | 
 51 | 	String methodname;
 52 | 	Collection<Object> args=new ArrayList<Object>();
 53 | 	Stack<Collection<Object>> stack=new Stack<Collection<Object>>();
 54 | 
 55 | 	public void addUntypedArg(Object arg)
 56 | 	{
 57 | 		args.add(arg);
 58 | 	}
 59 | 
 60 | 	public void addArg(String arg)
 61 | 	{
 62 | 		args.add(arg);
 63 | 	}
 64 | 	public void addArg(Boolean arg)
 65 | 	{
 66 | 		args.add(arg);
 67 | 	}
 68 | 	public void addArg(Integer arg)
 69 | 	{
 70 | 		args.add(arg);
 71 | 	}
 72 | 	public void addArg(Double arg)
 73 | 	{
 74 | 		args.add(arg);
 75 | 	}
 76 | 	public void addArg(List<Object> arg)
 77 | 	{
 78 | 		args.add(arg);
 79 | 	}
 80 | 	public void addArg(Map<String,Object> arg)
 81 | 	{
 82 | 		args.add(arg);
 83 | 	}
 84 | 	public void addArgWithTypeGuessing(String v)
 85 | 	{
 86 | 		if("[".equals(v))
 87 | 		{
 88 | 			// Begin array
 89 | 			stack.push(args);
 90 | 			args=new ArrayList<Object>();
 91 | 		}
 92 | 		else if("{".equals(v))
 93 | 		{
 94 | 			// Begin map
 95 | 			stack.push(args);
 96 | 			args=new ArrayList<Object>();
 97 | 		}
 98 | 		else if("]".equals(v))
 99 | 		{
100 | 			// End array
101 | 			Collection<Object> arr=args;
102 | 			args=stack.pop();
103 | 			args.add(arr);
104 | 		}
105 | 		else if("}".equals(v))
106 | 		{
107 | 			Collection<Object> arr=args;
108 | 
109 | 			// Unwind this into a tag value pair
110 | 			HashMap<String,Object> m=new HashMap<String,Object>();
111 | 			Iterator<Object> it=arr.iterator();
112 | 			while(it.hasNext())
113 | 			{
114 | 				m.put(it.next().toString(),it.next());
115 | 			}
116 | 			args=stack.pop();
117 | 			args.add(m);
118 | 		}
119 | 		else
120 | 			args.add(guessType(v));
121 | 	}
122 | 
123 | 	public Object guessType(String v)
124 | 	{
125 | 		if(v.equalsIgnoreCase("true")||v.equalsIgnoreCase("on"))
126 | 			return(Boolean.TRUE);
127 | 		else if(v.equalsIgnoreCase("false")||v.equalsIgnoreCase("off"))
128 | 			return(Boolean.FALSE);
129 | 		else if(v.matches("[0-9]+"))
130 | 			return(Integer.valueOf(v));
131 | 		else if(v.matches("[0-9]+\\.[0-9]+"))
132 | 			return(Double.valueOf(v));
133 | 		else
134 | 			return(v);
135 | 	}
136 | 
137 | 	public String getMethodName()
138 | 	{
139 | 		return methodname;
140 | 	}
141 | 
142 | 	public HMXRMsg(String methodname)
143 | 	{
144 | 		this.methodname=methodname;
145 | 	}
146 | 
147 | 	private void addList(Collection<?> args)
148 | 	{
149 | 		for(Object o:args)
150 | 		{
151 | 			if(o.getClass()==String.class)
152 | 			{
153 | 				addInt(3);
154 | 				String s=(String)o;
155 | 				addInt(s.length());
156 | 				addString(s);
157 | 			}
158 | 			else if(o.getClass()==Boolean.class)
159 | 			{
160 | 				addInt(2);
161 | 				addByte(((Boolean)o).booleanValue()?(byte)1:(byte)0);
162 | 			}
163 | 			else if(o.getClass()==Integer.class)
164 | 			{
165 | 				addInt(1);
166 | 				addInt(((Integer)o).intValue());
167 | 			}
168 | 			else if(o.getClass()==Double.class)
169 | 			{
170 | 				addInt(4);
171 | 				double v=Math.abs(((Double)o).doubleValue()),tmp=v;
172 | 				int exp=0;
173 | 				while(tmp>=2)
174 | 				{
175 | 					tmp=Math.abs(v/Math.pow(2,exp++));
176 | 				}
177 | 				int mantissa=(int)(Math.abs(v/Math.pow(2,exp))*0x40000000);
178 | 				// Note that this limits the range of the inbound double
179 | 				addInt(mantissa);
180 | 				addInt(exp);
181 | 			}
182 | 			else if(o instanceof List<?>)
183 | 			{
184 | 				Collection<?> l=(Collection<?>)o;
185 | 				addInt(0x100);
186 | 				addInt(l.size());
187 | 				addList(l);
188 | 			}
189 | 			else if(o instanceof Map<?,?>)
190 | 			{
191 | 				Map<?,?> l=(Map<?,?>)o;
192 | 				addInt(0x101);
193 | 				addInt(l.size());
194 | 				for(Map.Entry<?,?> me:l.entrySet())
195 | 				{
196 | 					String key = (String)me.getKey();
197 | 					addInt(key.length());
198 | 					addString(key);
199 | 					addList(Collections.singleton(me.getValue()));
200 | 				}
201 | 			}
202 | 		}
203 | 	}
204 | 
205 | 	public byte[] prepareData()
206 | 	{
207 | 		data=new byte[256];
208 | 		if(methodname!=null)
209 | 		{
210 | 			addInt(methodname.length());
211 | 			addString(methodname);
212 | 			addInt(args.size());
213 | 		}
214 | 
215 | 		addList(args);
216 | 
217 | 		byte fullreq[]=new byte[dataoffset+8];
218 | 		System.arraycopy(data,0,fullreq,8,dataoffset);
219 | 		fullreq[0]='B';
220 | 		fullreq[1]='i';
221 | 		fullreq[2]='n';
222 | 		//fullreq[3]=0;
223 | 		// Original request length
224 | 		addInt(dataoffset);
225 | 		System.arraycopy(data,dataoffset-4,fullreq,4,4);
226 | 		return fullreq;
227 | 	}
228 | 
229 | }
230 | 


--------------------------------------------------------------------------------
/src/com/vapor/hmcompanion/HMXRResponse.java:
--------------------------------------------------------------------------------
  1 | /*
  2 |  * Encapsulates a HomeMatic "XML-RPC" binary response
  3 |  */
  4 | package com.vapor.hmcompanion;
  5 | 
  6 | import java.io.*;
  7 | import java.math.*;
  8 | import java.net.*;
  9 | import java.text.*;
 10 | import java.util.*;
 11 | 
 12 | public class HMXRResponse
 13 | {
 14 | 	byte data[];
 15 | 	int dataoffset=0;
 16 | 	String methodName;
 17 | 
 18 | 	private int readInt()
 19 | 	{
 20 | 		// Extract 4 bytes
 21 | 		byte bi[]=new byte[4];
 22 | 		System.arraycopy(data,dataoffset,bi,0,4);
 23 | 		dataoffset+=4;
 24 | 		return (new BigInteger(bi)).intValue();
 25 | 	}
 26 | 
 27 | 	List<Object> rd=new ArrayList<Object>();
 28 | 
 29 | 	public List<Object> getData()
 30 | 	{
 31 | 		return rd;
 32 | 	}
 33 | 
 34 | 	private Object readRpcValue() throws UnsupportedEncodingException, ParseException
 35 | 	{
 36 | 		int type=readInt();
 37 | 		switch(type)
 38 | 		{
 39 | 			case 1:
 40 | 				return new Integer(readInt());
 41 | 			case 2:
 42 | 				return data[dataoffset++]!=0?Boolean.TRUE:Boolean.FALSE;
 43 | 			case 3:
 44 | 				int len=readInt();
 45 | 				dataoffset+=len;
 46 | 				return new String(data,dataoffset-len,len,"ISO-8859-1");
 47 | 			case 4:
 48 | 				int mantissa=readInt();
 49 | 				int exponent=readInt();
 50 | 				BigDecimal bd=new BigDecimal((double)mantissa/(double)(1<<30)*Math.pow(2,exponent));
 51 | 				return bd.setScale(2,RoundingMode.HALF_DOWN);
 52 | 			case 5:
 53 | 				return new Date(readInt()*1000);
 54 | 			case 0x100:
 55 | 				// Array
 56 | 				int numElements=readInt();
 57 | 				Collection<Object> array=new ArrayList<Object>();
 58 | 				while(numElements-->0)
 59 | 					array.add(readRpcValue());
 60 | 				return array;
 61 | 			case 0x101:
 62 | 				// Struct
 63 | 				numElements=readInt();
 64 | 				Map<String,Object> struct=new HMXRMap();
 65 | 				while(numElements-->0)
 66 | 				{
 67 | 					int slen=readInt();
 68 | 					String name=new String(data,dataoffset,slen,"ISO-8859-1");
 69 | 					dataoffset+=slen;
 70 | 					struct.put(name,readRpcValue());
 71 | 				}
 72 | 				return struct;
 73 | 
 74 | 			default:
 75 | 				for(int x=0;x<data.length;x++)
 76 | 				{
 77 | 					System.out.println(Integer.toHexString(data[x])+" "+(char)data[x]);
 78 | 				}
 79 | 				throw new ParseException("Unknown data type "+type, type);
 80 | 		}
 81 | 	}
 82 | 
 83 | 	HMXRResponse(byte[] buffer,boolean methodHeader) throws ParseException, UnsupportedEncodingException
 84 | 	{
 85 | 		data=buffer;
 86 | 
 87 | 		if(methodHeader)
 88 | 		{
 89 | 			int slen=readInt();
 90 | 			methodName=new String(data,dataoffset,slen,"ISO-8859-1");
 91 | 			dataoffset+=slen;
 92 | 			// Skip arg count
 93 | 			readInt();
 94 | 		}
 95 | 
 96 | 		while(dataoffset<data.length)
 97 | 		{
 98 | 			rd.add(readRpcValue());
 99 | 		}
100 | 	}
101 | 
102 | 	static public HMXRResponse readMsg(Socket s,boolean methodHeader) throws IOException, ParseException
103 | 	{
104 | 		// Read response
105 | 		byte sig[]=new byte[4];
106 | 		int l;
107 | 		l=s.getInputStream().read(sig);
108 | 		if(l!=sig.length)
109 | 			throw new EOFException("Only "+l+" bytes received reading signature");
110 | 		if(sig[0]!='B'||sig[1]!='i'||sig[2]!='n')
111 | 			throw new UnsupportedEncodingException("No BinX signature");
112 | 		// Obtain the data len
113 | 		l=s.getInputStream().read(sig);
114 | 		if(l!=sig.length)
115 | 			throw new EOFException("Only "+l+" bytes received reading length");
116 | 		int datasize=(new BigInteger(sig)).intValue();
117 | 		byte buffer[]=new byte[datasize];
118 | 		int offset=0;
119 | 		while(datasize>0)
120 | 		{
121 | 			int r=s.getInputStream().read(buffer,offset,datasize);
122 | 			if(r<1)
123 | 				throw new EOFException("EOF while reading data");
124 | 			datasize-=r;
125 | 			offset+=r;
126 | 		}
127 | 		/*
128 | 		for(int x=0;x<buffer.length;x++)
129 | 		{
130 | 			System.out.println(Integer.toHexString(buffer[x])+" "+(char)buffer[x]);
131 | 		}
132 | 		*/
133 | 		return new HMXRResponse(buffer,methodHeader);
134 | 	}
135 | 
136 | 
137 | 	@Override
138 | 	public String toString()
139 | 	{
140 | 		StringBuilder sb=new StringBuilder();
141 | 		if(methodName!=null)
142 | 		{
143 | 			sb.append(methodName);
144 | 			sb.append("()\n");
145 | 		}
146 | 		dumpCollection(rd,sb,0);
147 | 		return sb.toString();
148 | 	}
149 | 
150 | 	private void dumpCollection(Collection<?> c,StringBuilder sb,int indent)
151 | 	{
152 | 		if(indent>0)
153 | 		{
154 | 			for(int in=0;in<indent-1;in++)
155 | 				sb.append('\t');
156 | 			sb.append("[\n");
157 | 		}
158 | 		for(Object o:c)
159 | 		{
160 | 			if(o instanceof Map)
161 | 			{
162 | 				dumpMap((Map<?,?>)o,sb,indent+1);
163 | 			}
164 | 			else if(o instanceof Collection)
165 | 			{
166 | 				dumpCollection((Collection<?>)o,sb,indent+1);
167 | 			}
168 | 			else
169 | 			{
170 | 				for(int in=0;in<indent;in++)
171 | 					sb.append('\t');
172 | 				sb.append(o);
173 | 				sb.append('\n');
174 | 			}
175 | 		}
176 | 		if(indent>0)
177 | 		{
178 | 			for(int in=0;in<indent-1;in++)
179 | 				sb.append('\t');
180 | 			sb.append("]\n");
181 | 		}
182 | 	}
183 | 
184 | 	private void dumpMap(Map<?,?> c,StringBuilder sb,int indent)
185 | 	{
186 | 		if(indent>0)
187 | 		{
188 | 			for(int in=0;in<indent-1;in++)
189 | 				sb.append('\t');
190 | 			sb.append("{\n");
191 | 		}
192 | 		for(Map.Entry<?,?> me:c.entrySet())
193 | 		{
194 | 			Object o=me.getValue();
195 | 			for(int in=0;in<indent;in++)
196 | 				sb.append('\t');
197 | 			sb.append(me.getKey());
198 | 			sb.append('=');
199 | 			if(o instanceof Map<?,?>)
200 | 			{
201 | 				sb.append("\n");
202 | 				dumpMap((Map<?,?>)o,sb,indent+1);
203 | 			}
204 | 			else if(o instanceof Collection<?>)
205 | 			{
206 | 				sb.append("\n");
207 | 				dumpCollection((Collection<?>)o,sb,indent+1);
208 | 			}
209 | 			else
210 | 			{
211 | 				sb.append(o);
212 | 				sb.append('\n');
213 | 			}
214 | 		}
215 | 		if(indent>0)
216 | 		{
217 | 			for(int in=0;in<indent-1;in++)
218 | 				sb.append('\t');
219 | 			sb.append("}\n");
220 | 		}
221 | 	}
222 | }
223 | 


--------------------------------------------------------------------------------
/src/com/vapor/hmcompanion/ui/Device.java:
--------------------------------------------------------------------------------
  1 | package com.vapor.hmcompanion.ui;
  2 | 
  3 | import java.util.*;
  4 | 
  5 | import com.vapor.hmcompanion.*;
  6 | import com.vapor.hmcompanion.ui.RSSI.RSSIInfo;
  7 | 
  8 | public class Device implements Comparable<Device>
  9 | {
 10 | 	String address;
 11 | 	String interf;
 12 | 	String type;
 13 | 	String firmware;
 14 | 	boolean roaming;
 15 | 	boolean usesAES;
 16 | 
 17 | 	String name; // ReGa name
 18 | 
 19 | 	RSSIInfo ifrssi[];
 20 | 
 21 | 	Map<String,RSSIInfo> rssi=Collections.emptyMap();
 22 | 
 23 | 	private Device(String address, String interf, String type, boolean roaming, String firmware, Device parent)
 24 | 	{
 25 | 		this.address = address;
 26 | 		this.interf = interf;
 27 | 		this.type = type;
 28 | 		this.roaming = roaming;
 29 | 		this.firmware = firmware;
 30 | 		this.parent = parent;
 31 | 
 32 | 		makeRSSIInfo();
 33 | 	}
 34 | 
 35 | 	private void makeRSSIInfo()
 36 | 	{
 37 | 		ifrssi=new RSSIInfo[BidcosInterface.interfaceList.size()];
 38 | 		int bestValue=Integer.MIN_VALUE;
 39 | 		int bestIndex=-1;
 40 | 		for(int c=0;c<ifrssi.length;c++)
 41 | 		{
 42 | 			String ifadr=BidcosInterface.interfaceList.get(c).address;
 43 | 
 44 | 			ifrssi[c]=rssi.get(ifadr);
 45 | 			if(ifrssi[c]==null)
 46 | 				ifrssi[c]=new RSSIInfo();
 47 | 			ifrssi[c].isDef=ifadr.equals(interf);
 48 | 
 49 | 			if(ifrssi[c].to!=65536&&ifrssi[c].to>bestValue)
 50 | 			{
 51 | 				bestValue=ifrssi[c].to;
 52 | 				bestIndex=c;
 53 | 			}
 54 | 		}
 55 | 		for(int c=0;c<ifrssi.length;c++)
 56 | 		{
 57 | 			ifrssi[c].isBest=(c==bestIndex);
 58 | 			ifrssi[c].isWrong=(ifrssi[c].isDef && !ifrssi[c].isBest && bestIndex!=-1);
 59 | 		}
 60 | 	}
 61 | 
 62 | 	public Map<String,Device> subdevices;
 63 | 	Device parent;
 64 | 
 65 | 	static Map<String,Device> devices=new TreeMap<String,Device>();
 66 | 	static List<Device> deviceList=Collections.emptyList();
 67 | 
 68 | 	private Device(String address)
 69 | 	{
 70 | 		this.address = address;
 71 | 	}
 72 | 
 73 | 	HMXRMap valueParamsetDescription;
 74 | 
 75 | 	public HMXRMap getValueParamsetDescription()
 76 | 	{
 77 | 		if(valueParamsetDescription!=null)
 78 | 			return valueParamsetDescription;
 79 | 
 80 | 		HMXRMsg m=new HMXRMsg("getParamsetDescription");
 81 | 		m.addArg(address);
 82 | 		m.addArg("VALUES");
 83 | 		HMXRResponse r=MainWin.doRequest(m);
 84 | 
 85 | 		valueParamsetDescription=(HMXRMap)r.getData().get(0);
 86 | 		return valueParamsetDescription;
 87 | 	}
 88 | 
 89 | 	public HMXRMap getValues()
 90 | 	{
 91 | 		HMXRMsg m=new HMXRMsg("getParamset");
 92 | 		m.addArg(address);
 93 | 		m.addArg("VALUES");
 94 | 		HMXRResponse r=MainWin.doRequest(m);
 95 | 
 96 | 		return (HMXRMap)r.getData().get(0);
 97 | 	}
 98 | 
 99 | 	public void setValue(String n,Object v)
100 | 	{
101 | 		HMXRMsg m=new HMXRMsg("setValue");
102 | 		m.addArg(address);
103 | 		m.addArg(n);
104 | 		m.addUntypedArg(v);
105 | 		MainWin.doRequest(m);
106 | 	}
107 | 
108 | 	static void loadDeviceList()
109 | 	{
110 | 		HMXRMsg m=new HMXRMsg("listDevices");
111 | 		HMXRResponse r=MainWin.doRequest(m);
112 | 		Map<String,Device> devices=new HashMap<String,Device>();
113 | 		for(Object mi:(List<?>)r.getData().get(0))
114 | 		{
115 | 			HMXRMap o=(HMXRMap)mi;
116 | 			Device bi=new Device(
117 | 				o.getString("ADDRESS"),
118 | 				o.getString("INTERFACE"),
119 | 				o.getString("TYPE"),
120 | 				o.getInt("ROAMING")!=0,
121 | 				o.getString("FIRMWARE"),
122 | 				devices.get(o.getString("PARENT"))
123 | 			);
124 | 
125 | 			int aes=o.getInt("AES_ACTIVE");
126 | 			if(aes==1)
127 | 				bi.usesAES=true;
128 | 
129 | 			if(bi.parent!=null)
130 | 			{
131 | 				bi.parent.addChild(bi);
132 | 			}
133 | 			else
134 | 			{
135 | 				devices.put(bi.address,bi);
136 | 			}
137 | 
138 | 		}
139 | 		Device.devices=devices;
140 | 		Device.deviceList=new ArrayList<Device>(devices.values());
141 | 	}
142 | 
143 | 	private void addChild(Device bi)
144 | 	{
145 | 		if(subdevices==null)
146 | 			subdevices=new TreeMap<String,Device>();
147 | 		subdevices.put(bi.address,bi);
148 | 		if(bi.usesAES)
149 | 			usesAES=true;
150 | 	}
151 | 
152 | 	public String makeLabel()
153 | 	{
154 | 		StringBuilder l=new StringBuilder();
155 | 		l.append("<html>");
156 | 		l.append(address);
157 | 		if(usesAES)
158 | 		{
159 | 			if(roaming)
160 | 				l.append("<font color='red'>");
161 | 			else
162 | 				l.append("<font color='blue'>");
163 | 			l.append(" (AES)");
164 | 			l.append("</font>");
165 | 		}
166 | 		l.append("<br/>");
167 | 		l.append(name!=null?name:"(no ReGa name)");
168 | 		l.append("<br/>");
169 | 		l.append(type);
170 | 		l.append(" <small>(");
171 | 		l.append(firmware);
172 | 		l.append(")</small>");
173 | 
174 | 		return l.toString();
175 | 	}
176 | 
177 | 	public String getName()
178 | 	{
179 | 		if(name!=null)
180 | 			return name;
181 | 		else
182 | 			return address;
183 | 	}
184 | 
185 | 	public static void setNames(Map<String, String> names)
186 | 	{
187 | 		for(Device d:deviceList)
188 | 		{
189 | 			d.name=names.get(d.address);
190 | 			for(Device sd:d.subdevices.values())
191 | 				sd.name=names.get(sd.address);
192 | 		}
193 | 		List<Device> l=new ArrayList<Device>(deviceList);
194 | 		Collections.sort(l);
195 | 		Device.deviceList=l;
196 | 	}
197 | 
198 | 	public static void setRSSI(Map<String,Map<String,RSSIInfo>> rssi)
199 | 	{
200 | 		for(Device d:deviceList)
201 | 		{
202 | 			d.rssi=rssi.get(d.address);
203 | 			if(d.rssi==null)
204 | 				d.rssi=Collections.emptyMap();
205 | 			d.makeRSSIInfo();
206 | 		}
207 | 	}
208 | 
209 | 	private void setBidcosInterface()
210 | 	{
211 | 
212 | 		HMXRMsg m=new HMXRMsg("setBidcosInterface");
213 | 		m.addArg(address);
214 | 		m.addArg(interf);
215 | 		m.addArg(roaming);
216 | 		MainWin.doRequest(m);
217 | 
218 | 	}
219 | 
220 | 	public void setRoaming(boolean roaming)
221 | 	{
222 | 		if(roaming!=this.roaming)
223 | 		{
224 | 			this.roaming=roaming;
225 | 			setBidcosInterface();
226 | 		}
227 | 	}
228 | 	public void setInterface(String ifname)
229 | 	{
230 | 		if(!interf.equals(ifname))
231 | 		{
232 | 			this.interf=ifname;
233 | 			makeRSSIInfo();
234 | 			setBidcosInterface();
235 | 		}
236 | 	}
237 | 
238 | 	public int compareTo(Device o)
239 | 	{
240 | 		if(name!=null && o.name!=null)
241 | 		{
242 | 			int rc=name.compareTo(o.name);
243 | 			if(rc!=0)
244 | 				return rc;
245 | 		}
246 | 		return address.compareTo(o.address);
247 | 	}
248 | 
249 | 	public void setBestInterface()
250 | 	{
251 | 		int bestix=0;
252 | 		for(int ix=0;ix<ifrssi.length;ix++)
253 | 		{
254 | 			int v=ifrssi[ix].cmpVal();
255 | 			if(v>ifrssi[bestix].cmpVal())
256 | 				bestix=ix;
257 | 		}
258 | 		if(ifrssi[bestix].cmpVal()>Integer.MIN_VALUE)
259 | 			setInterface(BidcosInterface.interfaceList.get(bestix).address);
260 | 	}
261 | 
262 | 
263 | }
264 | 


--------------------------------------------------------------------------------
/src/com/vapor/hmcompanion/XMLRPCServer.java:
--------------------------------------------------------------------------------
  1 | /*
  2 |  * This is the client-side server process, used for sending commands to HMCompanion.
  3 |  *
  4 |  * Use a simple line-based protocol suitable for use with netcat or PHP
  5 |  */
  6 | 
  7 | package com.vapor.hmcompanion;
  8 | 
  9 | import java.io.*;
 10 | import java.net.*;
 11 | import java.text.*;
 12 | import java.util.*;
 13 | import java.util.logging.*;
 14 | 
 15 | public class XMLRPCServer extends Thread
 16 | {
 17 | 	private static ServerSocket ss;
 18 | 	static final int port=6778;
 19 | 	public static String init() throws IOException
 20 | 	{
 21 | 		ss=new ServerSocket();
 22 | 		ss.setReuseAddress(true);
 23 | 		ss.bind(new InetSocketAddress(port));
 24 | 		new XMLRPCAcceptor().start();
 25 |         InetAddress addr=InetAddress.getLocalHost();
 26 |         return "binary://"+System.getProperty("hmc.localhost",addr.getHostAddress())+":"+port;
 27 | 	}
 28 | 
 29 | 	static long lastRequest;
 30 | 
 31 | 	static final class XMLRPCAcceptor extends Thread
 32 | 	{
 33 | 		@Override
 34 | 		public void run()
 35 | 		{
 36 | 			try
 37 | 			{
 38 | 				for(;;)
 39 | 				{
 40 | 					Socket s=ss.accept();
 41 | 					s.setKeepAlive(true);
 42 | 					new XMLRPCServer(s).start();
 43 | 				}
 44 | 			}
 45 | 			catch(Exception e)
 46 | 			{
 47 | 				/* Ignore */
 48 | 			}
 49 | 		}
 50 | 	}
 51 | 
 52 | 	static Map<String,Long> stats=new HashMap<String,Long>();
 53 | 	@SuppressWarnings("boxing")
 54 | 	static void incMsg(String key)
 55 | 	{
 56 | 		Long l=stats.get(key);
 57 | 		if(l==null)
 58 | 			stats.put(key,new Long(1));
 59 | 		else
 60 | 			stats.put(key,l+1);
 61 | 	}
 62 | 
 63 | 	@SuppressWarnings("boxing")
 64 | 	static long getStats(String which)
 65 | 	{
 66 | 		Long l=stats.get(which);
 67 | 		if(l==null)
 68 | 			return 0;
 69 | 		else
 70 | 			return l;
 71 | 	}
 72 | 
 73 | 	Socket s;
 74 | 	OutputStream os;
 75 | 	XMLRPCServer(Socket s)
 76 | 	{
 77 | 		super("Handler for "+s);
 78 | 		this.s=s;
 79 | 	}
 80 | 
 81 | 	private static Map<String,String> buttonlinks=new HashMap<String,String>();
 82 | 	private static Set<String> buttonlong=new HashSet<String>();
 83 | 	static {
 84 | 		String bm=System.getProperty("hmc.buttonlinks");
 85 | 		if(bm!=null)
 86 | 		{
 87 | 			String bms[]=bm.split(",");
 88 | 			for(String b:bms)
 89 | 			{
 90 | 				String parts[]=b.split("=",2);
 91 | 				buttonlinks.put(parts[0],parts[1]);
 92 | 			}
 93 | 		}
 94 | 	}
 95 | 
 96 | 	private void doExec(String exec, String address, String item, String val)
 97 | 	{
 98 | 		String cmd=exec+" \""+address+"\" \""+item+"\"";
 99 | 		if(val!=null)
100 | 			cmd=cmd+" \""+val+"\"";
101 | 		try
102 | 		{
103 | 			HMC.l.info("Executing '"+cmd+"'");
104 | 			Runtime.getRuntime().exec(cmd);
105 | 		}
106 | 		catch (IOException ioe)
107 | 		{
108 | 			HMC.l.log(Level.WARNING, "Failed to execute '"+cmd+"'", ioe);
109 | 		}
110 | 	}
111 | 
112 | 	private void tryExec(String address, String item, String val)
113 | 	{
114 | 		String key=address+"."+item+"."+val;
115 | 		String exec=System.getProperty(key);
116 | 		if(exec!=null)
117 | 		{
118 | 			doExec(exec, address, item, val);
119 | 			return;
120 | 		}
121 | 		ReGaItem dev=ReGaDeviceCache.getItemByName(address);
122 | 		if(dev==null)
123 | 			return;
124 | 		key=dev.name+"."+item+"."+val;
125 | 		exec=System.getProperty(key);
126 | 		if(exec==null)
127 | 			return;
128 | 		doExec(exec, dev.name, item, val);
129 | 	}
130 | 
131 | 	private String handleEvent(List<?> parms)
132 | 	{
133 | 		String address=parms.get(1).toString();
134 | 		String item=parms.get(2).toString();
135 | 		Object val=parms.get(3);
136 | 		AttributeCache.putAttribute(address,item,val);
137 | 		tryExec(address, item, val==null?null:val.toString());
138 | 		// Check button mappings
139 | 		if(item.startsWith("PRESS_")||("INSTALL_TEST".equals(item)&&buttonlong.contains(address)))
140 | 		{
141 | 			String dest=buttonlinks.get(address);
142 | 			if(dest!=null)
143 | 			{
144 | 				if("PRESS_LONG".equals(item))
145 | 					buttonlong.add(address);
146 | 				else if("PRESS_SHORT".equals(item))
147 | 					buttonlong.remove(address);
148 | 				else
149 | 					item="PRESS_LONG";
150 | 
151 | 				Collection<ReGaItem> items=ReGaDeviceCache.getItemsByName(dest);
152 | 				HMC.l.fine("Mapping button "+item+"="+val+" from "+address+" to "+dest+" ("+items+")");
153 | 				if(items!=null)
154 | 				{
155 | 					for(ReGaItem it:items)
156 | 					{
157 | 						final int dix;
158 | 						if("BidCos-RF".equals(it.interf))
159 | 							dix=1;
160 | 						else if("BidCos-Wired".equals(it.interf))
161 | 							dix=0;
162 | 						else
163 | 							dix=2;
164 | 
165 | 						final HMXRMsg m=new HMXRMsg("setValue");
166 | 						m.addArg(it.address);
167 | 						m.addArg(item);
168 | 						m.addArg(Boolean.TRUE);
169 | 						// Send on second thread
170 | 						new Thread(){
171 | 							@Override
172 | 							public void run()
173 | 							{
174 | 								try
175 | 								{
176 | 									HMC.connections[dix].sendRequest(m);
177 | 								}
178 | 								catch(Exception e)
179 | 								{
180 | 									/* Ignore, don't care */
181 | 								}
182 | 							}
183 | 						}.start();
184 | 					}
185 | 				}
186 | 			}
187 | 		}
188 | 
189 | 		if(val!=null)
190 | 			GraphiteInterface.sendToCarbon(address, item, val.toString());
191 | 
192 | 		return parms.get(0).toString();
193 | 	}
194 | 
195 | 	private void handleMethodCall(HMXRResponse r) throws IOException
196 | 	{
197 | 		lastRequest=System.currentTimeMillis();
198 | 		if("event".equals(r.methodName))
199 | 		{
200 | 			String cb=handleEvent(r.rd);
201 | 			incMsg(cb);
202 | 			os.write(bEmptyString);
203 | 		}
204 | 		else if("listDevices".equals(r.methodName))
205 | 		{
206 | 			os.write(bEmptyArray);
207 | 		}
208 | 		else if("newDevices".equals(r.methodName))
209 | 		{
210 | 			// Hm we ignore that
211 | 			os.write(bEmptyArray);
212 | 		}
213 | 		else if("system.listMethods".equals(r.methodName))
214 | 		{
215 | 			HMXRMsg m=new HMXRMsg(null);
216 | 			List<Object> result=new ArrayList<Object>();
217 | 			result.add("event");
218 | 			m.addArg(result);
219 | 			os.write(m.prepareData());
220 | 		}
221 | 		else if("system.multicall".equals(r.methodName))
222 | 		{
223 | 			HMXRMsg m=new HMXRMsg(null);
224 | 
225 | 			List<Object> result=new ArrayList<Object>();
226 | 
227 | 			String cb=null;
228 | 
229 | 			for(Object o:(List<?>)r.rd.get(0))
230 | 			{
231 | 				Map<?,?> call=(Map<?,?>)o;
232 | 				String method=call.get("methodName").toString();
233 | 				if("event".equals(method))
234 | 				{
235 | 					cb=handleEvent((List<?>)call.get("params"));
236 | 				}
237 | 				else
238 | 					HMC.l.warning("Unknown method in multicall called by CCU:"+method);
239 | 
240 | 				result.add(Collections.singletonList(""));
241 | 			}
242 | 
243 | 			incMsg(cb);
244 | 
245 | 			m.addArg(result);
246 | 			os.write(m.prepareData());
247 | 		}
248 | 		else
249 | 		{
250 | 			HMC.l.warning("Unknown method called by CCU: "+r.methodName);
251 | 		//	os.write(bfalse);
252 | 		}
253 | 	}
254 | 
255 | 	static final byte bEmptyString[]={'B','i','n',0, 0,0,0,8, 0,0,0,3, 0,0,0,0};
256 | 	static final byte bEmptyArray[]={'B','i','n',0, 0,0,0,8, 0,0,1,0, 0,0,0,0};
257 | 
258 | 	static final byte btrue[]= {'B','i','n',0, 0,0,0,5, 0,0,0,2, 1};
259 | 	static final byte bfalse[]={'B','i','n',0, 0,0,0,5, 0,0,0,2, 1};
260 | 
261 | 	@Override
262 | 	public void run()
263 | 	{
264 | 		HMC.l.fine("Accepted XMLRPC-BIN connection from "+s.getRemoteSocketAddress());
265 | 		try
266 | 		{
267 | 			os=s.getOutputStream();
268 | 			for(;;)
269 | 			{
270 | 				HMXRResponse r=HMXRResponse.readMsg(s,true);
271 | 				handleMethodCall(r);
272 | 			}
273 | 		}
274 | 		catch(EOFException eof)
275 | 		{
276 | 			/* Client closed, ignore */
277 | 		}
278 | 		catch(Exception e)
279 | 		{
280 | 			HMC.l.log(Level.INFO,"Closing connection",e);
281 | 		}
282 | 		finally
283 | 		{
284 | 			try
285 | 			{
286 | 				s.close();
287 | 			}
288 | 			catch(Exception e)
289 | 			{
290 | 				// We don't care here
291 | 			}
292 | 		}
293 | 	}
294 | }
295 | 


--------------------------------------------------------------------------------
/src/com/vapor/hmcompanion/ui/MainWin.java:
--------------------------------------------------------------------------------
  1 | package com.vapor.hmcompanion.ui;
  2 | 
  3 | import java.awt.*;
  4 | import java.awt.event.*;
  5 | import java.io.*;
  6 | import java.util.*;
  7 | import java.util.logging.*;
  8 | 
  9 | import javax.swing.*;
 10 | 
 11 | import com.vapor.hmcompanion.*;
 12 | 
 13 | public class MainWin extends JFrame
 14 | {
 15 | 	static MainWin win;
 16 | 	static HMXRConnection con;
 17 | 
 18 | 	private JLabel statusbar;
 19 | 
 20 | 	JTable tab_rssi;
 21 | 	DevRSSIModel model_rssi;
 22 | 
 23 | 	private MainWin()
 24 | 	{
 25 | 		super("HMCompanion V"+HMC.version+" - (C) 2012 Oliver Wagner <owagner@vapor.com>, All Rights Reserved");
 26 | 		setDefaultCloseOperation(EXIT_ON_CLOSE);
 27 | 
 28 | 		ImageIcon appiconIcon=new ImageIcon(getClass().getResource("icon.png"));
 29 | 		setIconImage(appiconIcon.getImage());
 30 | 
 31 | 		JPanel panel_buttons=new JPanel();
 32 | 
 33 | 		JButton bt_reload=new JButton("Refresh RSSI");
 34 | 		panel_buttons.add(bt_reload);
 35 | 
 36 | 		panel_buttons.add(new JSeparator(SwingConstants.VERTICAL));
 37 | 
 38 | 		JButton bt_best=new JButton("Default To Best");
 39 | 		panel_buttons.add(bt_best);
 40 | 
 41 | 		JButton bt_roamingoff=new JButton("Roaming Off All");
 42 | 		panel_buttons.add(bt_roamingoff);
 43 | 
 44 | 		JButton bt_roamingon=new JButton("Roaming On HM-RC");
 45 | 		panel_buttons.add(bt_roamingon);
 46 | 
 47 | 		JPanel panel_main=new JPanel(new BorderLayout());
 48 | 
 49 | 		statusbar=new JLabel("Starting up...");
 50 | 		statusbar.setBorder(BorderFactory.createLoweredBevelBorder());
 51 | 		getContentPane().add(statusbar,BorderLayout.SOUTH);
 52 | 
 53 | 		model_rssi=new DevRSSIModel();
 54 | 		tab_rssi=new JTable(model_rssi);
 55 | 
 56 | 		tab_rssi.addMouseListener(new MouseAdapter(){
 57 | 
 58 | 			@Override
 59 | 			public void mousePressed(MouseEvent e)
 60 | 			{
 61 | 				checkPopup(e);
 62 | 			}
 63 | 
 64 | 			@Override
 65 | 			public void mouseReleased(MouseEvent e)
 66 | 			{
 67 | 				checkPopup(e);
 68 | 			}
 69 | 
 70 | 			private void checkPopup(MouseEvent e)
 71 | 			{
 72 | 				if(e.isPopupTrigger())
 73 | 					showDevicePopup(e);
 74 | 			}
 75 | 
 76 | 		});
 77 | 
 78 | 		panel_main.add(panel_buttons,BorderLayout.NORTH);
 79 | 		panel_main.add(new JScrollPane(tab_rssi),BorderLayout.CENTER);
 80 | 
 81 | 		getContentPane().add(panel_main);
 82 | 
 83 | 		// Events
 84 | 		bt_reload.addActionListener(new ActionListener(){
 85 | 			public void actionPerformed(ActionEvent arg0)
 86 | 			{
 87 | 				refreshRSSI();
 88 | 			}
 89 | 		});
 90 | 		bt_best.addActionListener(new ActionListener(){
 91 | 			public void actionPerformed(ActionEvent arg0)
 92 | 			{
 93 | 				setDefaultToBest();
 94 | 			}
 95 | 		});
 96 | 		bt_roamingon.addActionListener(new ActionListener(){
 97 | 			public void actionPerformed(ActionEvent arg0)
 98 | 			{
 99 | 				setRoamingOn();
100 | 			}
101 | 		});
102 | 		bt_roamingoff.addActionListener(new ActionListener(){
103 | 			public void actionPerformed(ActionEvent arg0)
104 | 			{
105 | 				setRoamingOff();
106 | 			}
107 | 		});
108 | 	}
109 | 
110 | 	protected void showDevicePopup(MouseEvent e)
111 | 	{
112 | 		// Determine the currently selected device
113 | 		int row=tab_rssi.rowAtPoint(e.getPoint());
114 | 		Device d=Device.deviceList.get(row);
115 | 
116 | 		JPopupMenu m=new DevicePopupMenu(d);
117 | 		m.show(e.getComponent(),e.getX(),e.getY());
118 | 	}
119 | 
120 | 	protected void setRoamingOff()
121 | 	{
122 | 		if(JOptionPane.showConfirmDialog(this,"<html>Set all Devices to <b>Roaming off</b>?","Roaming Off",JOptionPane.YES_NO_OPTION)!=JOptionPane.YES_OPTION)
123 | 			return;
124 | 
125 | 		for(Device d:Device.deviceList)
126 | 			d.setRoaming(false);
127 | 		tab_rssi.repaint();
128 | 	}
129 | 
130 | 	protected void setRoamingOn()
131 | 	{
132 | 		if(JOptionPane.showConfirmDialog(this,"<html>Set all Remotes (HM-RC-*) to <b>Roaming on</b>?","Roaming On HM-RC",JOptionPane.YES_NO_OPTION)!=JOptionPane.YES_OPTION)
133 | 			return;
134 | 
135 | 		for(Device d:Device.deviceList)
136 | 		{
137 | 			if(d.type.startsWith("HM-RC"))
138 | 				d.setRoaming(true);
139 | 		}
140 | 		tab_rssi.repaint();
141 | 	}
142 | 
143 | 	protected void setDefaultToBest()
144 | 	{
145 | 		if(JOptionPane.showConfirmDialog(this,"<html>Set all Devices default IF to <b>Best RSSI</b>?","Default To Best RSSI",JOptionPane.YES_NO_OPTION)!=JOptionPane.YES_OPTION)
146 | 			return;
147 | 
148 | 		for(Device d:Device.deviceList)
149 | 		{
150 | 			d.setBestInterface();
151 | 		}
152 | 		tab_rssi.repaint();
153 | 	}
154 | 
155 | 	void refreshRSSI()
156 | 	{
157 | 		new Thread(){
158 | 			@Override
159 | 			public void run()
160 | 			{
161 | 				RSSI.loadRSSIInfo();
162 | 				tab_rssi.repaint();
163 | 			}
164 | 		}.start();
165 | 	}
166 | 
167 | 	public static void launchUI(String host,String port)
168 | 	{
169 | 		try
170 | 		{
171 | 			UIManager.setLookAndFeel(UIManager.getSystemLookAndFeelClassName());
172 | 			JFrame.setDefaultLookAndFeelDecorated(true);
173 | 		}
174 | 		catch(Exception e)
175 | 		{
176 | 			/* Ignore */
177 | 		}
178 | 
179 | 		win=new MainWin();
180 | 		win.pack();
181 | 		win.setLocationByPlatform(true);
182 | 		win.setVisible(true);
183 | 
184 | 		win.doLogin(host,port);
185 | 	}
186 | 
187 | 	public static HMXRResponse doRequest(HMXRMsg m)
188 | 	{
189 | 		try
190 | 		{
191 | 			win.statusbar.setText("Executing "+m.getMethodName()+"...");
192 | 			win.setCursor(Cursor.getPredefinedCursor(Cursor.WAIT_CURSOR));
193 | 			HMXRResponse r=con.sendRequest(m);
194 | 			win.statusbar.setText("Method "+m.getMethodName()+" completed");
195 | 			return r;
196 | 		}
197 | 		catch(Exception e)
198 | 		{
199 | 			JOptionPane.showMessageDialog(win,
200 | 				"Connection to BidCoS-Server/CCU failed:\n"+e.getLocalizedMessage(),
201 | 				"Error",
202 | 				JOptionPane.ERROR_MESSAGE
203 | 			);
204 | 			return null;
205 | 		}
206 | 		finally
207 | 		{
208 | 			win.setCursor(Cursor.getDefaultCursor());
209 | 		}
210 | 	}
211 | 
212 | 	private boolean tryLogin(String host,String port) throws IOException
213 | 	{
214 | 		String ps[]=port.split(" ");
215 | 
216 | 		con=new HMXRConnection(
217 | 			host,
218 | 			Integer.parseInt(ps[0]),
219 | 			null,
220 | 			0
221 | 		);
222 | 
223 | 		// Check connection
224 | 		HMXRMsg m=new HMXRMsg("system.listMethods");
225 | 		doRequest(m);
226 | 
227 | 		TCLRegaHandler.setHMHost(host);
228 | 
229 | 		BidcosInterface.loadInterfacelist();
230 | 		Device.loadDeviceList();
231 | 
232 | 		Map<String,String> names=ReGaDeviceCache.loadDeviceNames();
233 | 		Device.setNames(names);
234 | 
235 | 		RSSI.loadRSSIInfo();
236 | 
237 | 		model_rssi.fireTableStructureChanged();
238 | 
239 | 		RSSIRenderer r=new RSSIRenderer();
240 | 		for(int c=1;c<1+BidcosInterface.interfaceList.size();c++)
241 | 		{
242 | 			tab_rssi.getColumnModel().getColumn(c).setCellRenderer(r);
243 | 			tab_rssi.getColumnModel().getColumn(c).setCellEditor(r.editor);
244 | 		}
245 | 
246 | 		tab_rssi.setRowHeight(tab_rssi.getRowHeight()*3);
247 | 
248 | 		return false;
249 | 	}
250 | 
251 | 	private void doLogin(String host,String port)
252 | 	{
253 | 		JComboBox comb_host=new JComboBox();
254 | 		JComboBox comb_port=new JComboBox();
255 | 
256 | 		comb_host.setEditable(true);
257 | 		comb_port.setEditable(true);
258 | 
259 | 		comb_port.addItem("2001 (BidCoS-RF)");
260 | 		comb_port.addItem("2000 (BidCoS-Wired)");
261 | 		comb_port.addItem("2002 (pfmd)");
262 | 		comb_port.addItem("8701 (CUxD)");
263 | 
264 | 		if(host!=null)
265 | 			comb_host.addItem(host);
266 | 
267 | 		JPanel selpanel=new JPanel(new GridLayout(2,2, 4,4));
268 | 
269 | 		selpanel.add(new JLabel("CCU/BidCoS service hostname or IP address:"));
270 | 		selpanel.add(comb_host);
271 | 		selpanel.add(new JLabel("Service name or port number:",SwingConstants.RIGHT));
272 | 		selpanel.add(comb_port);
273 | 
274 | 		int rc=JOptionPane.showConfirmDialog(win,
275 | 			selpanel,
276 | 			"Connect to CCU",
277 | 			JOptionPane.OK_CANCEL_OPTION,
278 | 			JOptionPane.QUESTION_MESSAGE
279 | 		);
280 | 		if(rc==JOptionPane.CANCEL_OPTION)
281 | 			System.exit(0);
282 | 
283 | 		try
284 | 		{
285 | 			tryLogin(comb_host.getSelectedItem().toString(),comb_port.getSelectedItem().toString());
286 | 		}
287 | 		catch(Exception e)
288 | 		{
289 | 			/* Ignore */
290 | 			HMC.l.log(Level.WARNING,"Login failed",e);
291 | 		}
292 | 
293 | 	}
294 | 
295 | }
296 | 


--------------------------------------------------------------------------------
/ReadMe.txt:
--------------------------------------------------------------------------------
  1 | [Please note: The middleware aspect of this software has been superseded by https://github.com/owagner/hm2mqtt]
  2 | 
  3 | HMCompanion V0.22
  4 | =================
  5 | Geschrieben von Oliver Wagner <owagner@vapor.com>
  6 | 
  7 | 1. Was ist HMCompanion?
  8 | -----------------------
  9 | HMCompanion ist eine Middleware, welche ich gebaut habe, um mein Homematic-System via CCU besser
 10 | in meine Hausautomation integrieren zu können. Es handelt sich um einen Server-Prozess, der
 11 | auf der einen Seite mit der CCU kommuniziert und auf anderen Seite mittels einfacher 
 12 | TCP-Textkommandos ansteuerbar ist. Dies ermöglicht eine sehr einfache Integration in
 13 | PHP, Bash-Scripte etc. Desweiteren arbeitet HMCompanion auch als sehr effizienter Cache
 14 | für den Status aller Channel auf der CCU, so daß z.B. für Visualisierung auf diese
 15 | Daten ohne Verzögerung zugegriffen werden kann.
 16 | 
 17 | HMCompanion ist in Java geschrieben und funktioniert auf jeder Plattform mit mindestens
 18 | einer Java-1.5-JRE (also NICHT direkt auf der CCU selbst)
 19 | 
 20 | 
 21 | 2. Grobe Struktur der CCU-Software
 22 | -----------------------------------
 23 | Um die Funktionsweise von HMCompanion zu verstehen, ist es sinnvoll, einen groben Überblick
 24 | über die Struktur der CCU-Software zu haben.
 25 | 
 26 | Die CCU-Software besteht aus mehreren Schichten:
 27 | 
 28 | Auf der untersten Ebene liegen drei Daemon-Prozesse, welche die Kommunikation mit den 
 29 | Hardwarekomponenten vornehmen:
 30 | 
 31 | rfd    -- mit den BidCoS-Funk-Komponenten (direkt oder über HM-CFG-LAN) (Port 2001)
 32 | hs485d -- mit den HomeMatic-Wired-Komponenten (Port 2000)
 33 | pfmd   -- mit der Hardware der CCU selbst (Port 2002)
 34 | 
 35 | Der CUxD ist, wenn installiert, ein ebensolcher Daemon (Port 8701)
 36 | 
 37 | Diese Prozesse besitzen jeweils eine xmlrpc-Schnittstelle, über welche sie angesteuert werden
 38 | können und über welche Ereignisse (z.B. Status-Änderungen) gemeldet werden. Auf dieser Ebene existieren
 39 | Geräte und Kanäle nur als Adressen.
 40 | 
 41 |        +--------+
 42 |        | WebUI  |
 43 |        +--------+
 44 |            | JSON-RPC
 45 |        +---------+
 46 |        |Webserver|
 47 |        +---------+
 48 |            | HMScript (und xmlrpc)       
 49 |        +--------+
 50 |        |ReGa HSS|
 51 |        +--------+________
 52 |       / xml |    \       \
 53 |      /  rpc |     \       \
 54 | +---+   +-------+  +----+  +----+
 55 | |rfd|   |hs485d |  |pfmd|  |CuXD|
 56 | +---|   +-------+  +----+  +----+
 57 |  | (TCP/IP)
 58 | +----------+
 59 | |HM-CFG-LAN|
 60 | +----------+
 61 | 
 62 | Über diesen Prozessen liegt die von EQ-3 als "Logikschicht" bezeichnete Ebene (ReGa, von "Residential Gateway").
 63 | Diese managt die Konfiguration der Hardwarekomponenten, führt WebUI-Programme aus, handhabt die Abarbeitung 
 64 | von HMScript und ähnliches. Auf dieser Ebene werden auch die Namen und Bezeichnungen der Geräte verwaltet
 65 | (in der "homematic.regadom"-Datenbank).
 66 | 
 67 | Diese Logikschicht wiederum besitzt zwei Schnittstellen: Zum einen die Möglichkeit, über eine TCL-Bibliothek
 68 | HMScript-Befehle auszuführen zu lassen, zum anderen ist über einen Webserver damit ein JSON-RPC-API
 69 | realisiert, welches wiederum von der WebUI verwendet wird. Das WebUI wiederum ist eine browserseitige
 70 | AJAX-Applikation, welche die Daten der ReGa visualisiert und die ReGa (via JSON-RPC) ansteuert. 
 71 | 
 72 | Die JSON-API-Befehle kann man mittels http://homematic-ip/api/homematic.cgi einsehen. Wer telnet-Zugang auf
 73 | die CCU hat, kann den TCL-Quelltext der einzelnen über das API verfügbaren Methoden im Verzeichnis /www/api/methods
 74 | einsehen. Diese lassen auch interessante Rückschlüsse auf interne HMScript- und xmlrpc-Aufrufe zu.
 75 | 
 76 | Eine Dokumentation der XML-RPC-Schnittstelle bfindet sich auf der Hersteller-Website unter
 77 | http://www.eq-3.de/software.html
 78 | 
 79 | 
 80 | 3. Kommunikation HMCompanion und CCU
 81 | ------------------------------------
 82 | HMCompanion kommuniziert auf zwei Ebenen mit der CCU:
 83 | 
 84 | a) Es benutzt xmlrpc, um direkt Befehle an rfd, hs485, pfmd und -- falls installiert, CUxD -- zu schicken.
 85 | a.1) Es meldet sich mittels des xmlrpc-Befehls "init" als zusätzliche Logikschicht an den Daemonen an, um 
 86 | von diesen über Ereignisse informiert zu werden. Dies macht die Installation von tcpdump o.ä. auf der CCU 
 87 | selbst unnötig.
 88 | 
 89 | Die xmlrpc-Kommunikation geht über die entsprechenden Schnittstellen der drei Serverdienste. Es wird das
 90 | proprietäre binärkodierte Format der CCU-Komponenten verwendet.
 91 | 
 92 | b) Es benutzt HMScript, um von der CCU eine Liste aller Geräte mit Namen zu erhalten, damit diese dann
 93 | mittels GET, SET etc. per Namen angesprochen werden können.  
 94 | 
 95 | HMScript wird mittels eines HTTP POST an die URL http://<homematic>:8181/tclrega.exe ausgeführt.
 96 | 
 97 | 
 98 | 4. Benutzung von HMCompanion
 99 | ----------------------------
100 | HMCompanion wird mit folgendem Befehl gestartet:
101 | 
102 | java -jar hmcompanion.jar <ip oder hostname der CCU> -server <optionaler Port, ansonsten 6770> <optionales password>
103 | 
104 | HMCompanion registriert sich dann zuerst per xmlrpc-API bei den vier Daemon-Prozessen, um Events zu erhalten,
105 | fordert danach per HMScript die ReGa-Geräteliste an und wartet dann auf TCP-Verbindungen zum
106 | angegebenen Port.  
107 | 
108 | Zum Beispiel mittels 
109 | 
110 | 	telnet localhost 6770
111 | 	
112 | kann man sich dann mit dem HMCompanion verbinden und Befehle abschicken. Mittels "HELP" erhält man
113 | eine Auflistung aller verfügbaren Befehle. Ein Beispiel: Aktuellen Status eines Channel-Attributes abrufen:
114 | 
115 | GET Wetterstation
116 | 
117 | Attribut setzen:
118 | 
119 | SET "Licht Kellerflur" STATE on
120 | 
121 | Bei SET/GET können jeweils sowohl die BidCoS-Adressen der Channel als auch die im WebUI zugewiesene
122 | Namen verwendet werden. Bei Set/SetParam können auch Wildcards verwendet werden, z.B.
123 | 
124 | SET "*Licht*" STATE on
125 | 
126 | setzt alle Komponenten mit Namen, die "Licht" enthalten, auf ein. Das Auslesen von Attributen von
127 | mehreren Geräten ist mittels des Befehls "MGET" möglich.
128 | 
129 | Da in den xmlrpc-Requests die Datentypen der Parameter eine Rolle spielen, rät HMCompanion anhand des
130 | Formats:
131 | 
132 |   on/true, off/false -> Boolean
133 |   Integer-Zahl (nur 0-9) -> Integer
134 |   Dezimalzahl (d.h. mit Dezimalpunkt) -> Dezimalzahl
135 |   alles andere -> String
136 |   
137 | Dies bedeutet, dass man Parameter, die als Dezimalzahl erwartet werden (z.B. LEVEL), immer auch als
138 | Dezimalzahl übergeben muss, also "0.0" statt "0" und "1.0" statt "1", ansonsten wird der Request vom
139 | jeweiligen Daemon ignoriert.
140 | 
141 | HMCompanion speichert den aktuellen Stand aller Channel-Attribute beim Beenden in der Datei "hmc.cache"
142 | und lädt diesen beim Start wieder. Dies dient insbesondere für Geräte, die nur alle 24h o.ä. ein Update
143 | schicken.
144 | 
145 | Wird HMCompanion auf einem Server-System betrieben, macht es Sinn, die Speicherzuteilung der JavaVM
146 | mittels "-Xmx64M" auf 64MB zu beschränken:
147 | 
148 | 	java -Xmx64M -jar hmcompanion.jar <ip oder hostname der CCU> -server
149 | 
150 | Hat ein System eine aktivierte, aber unvollständige IPv6-Konfiguration, kann es nötig sein, den Parameter 
151 | "-Djava.net.preferIPv4Stack=true" zu setzen, um zu verhindern, dass eine fehlerhafte Callback-Adresse
152 | ermittelt wird.  
153 | 
154 | 
155 | 5. Events
156 | ---------
157 | Es besteht die Möglichkeit, Events zu definieren, um beim Auftreten von bestimmten Zuständsänderungen Scripte
158 | auszuführen. Diese werden in der Form
159 | 
160 |   Kanalname_oder_adresse.Attribut.Wert=script
161 |   
162 | definiert, zum Beispiel
163 | 
164 |   BidCoS-Wir:10.PRESS_SHORT.true=/pfad/zum/skript.sh
165 |   
166 | Diese Events können entweder als Property beim Start von HMC mitgegeben (-DBidCoS-Wir:10.PRESS_SHORT.true=/pfad/zum/skript.sh)
167 | oder in der optionalen Datei "hmcompanion.cfg" definiert werden.
168 | 
169 | 
170 | 6. Interface zu Graphite/Carbon
171 | -------------------------------
172 | HMC kann sämtliche Statusänderungen auch als Metric an einen carbon-Server des Graphite-Pakets (http://graphite.wikidot.com/)
173 | schicken. Hier muss die Netzwerkadresse des Carbon-Servers mittels der Property
174 | 
175 | -Dhmc.carbon.host=<hostname oder IP>
176 | 
177 | festgelegt werden. Die Namen der Metriken werden aus dem ReGaHSS-Gerätenamen und dem Attributnamen gebildet, mit dem
178 | zusätzlichen Präfix, welches per "-Dhmc.carbon.prefix=" festgelegt ist (Default ist "hm."). Dabei wird alles in
179 | Kleinbuchstaben verwandelt und alle unzulässigen Zeichen werden in "_" umgewandelt. Boolsche Werte werden dabei in numerisch
180 | 0 bzw. 1 umgesetzt. 
181 | 
182 | Beispiel: Das Attribut "RAINING" des Gerätes "Wetterstation Aussen" ergibt den Metriknamen
183 | 
184 | hm.wetterstation_aussen.raining 
185 | 
186 | 
187 | 7. History
188 | ----------
189 | V0.2 - erste funktionale Version
190 | 
191 | V0.3 - verwendet XMLRPC-BIN auch für eingehende Requests, kein Apache ws-xmlrpc mehr nötig
192 |      - Dump-Format für strukturierte Antworten verbessert
193 |      - Serialization-Fehler beim Cache-Schreiben behoben
194 |      - Neues Kommando "CGET", um alle Attribute eines Kanals in einem für Cacti lesbarem Format
195 |        auszugeben
196 | 
197 | V0.4 - SET funktioniert nun auch wieder mit reinen BidCoS-Adressen anstatt nur mit ReGa-Namen
198 |      - neuer Befehl "SETPARAM", um einen einzelnen Konfigurationsparameter via der xmlrpc-Methode
199 |        "putParamset" zu setzen. Beispiel z.B. zum Setzen eines Temperaturreglers auf Automatik:
200 |        SETPARAM GEQ00xxxxx:2 MASTER MODE_TEMPERATUR_REGULATOR 1
201 | 
202 | V0.5 - SET und SETPARAM akzeptieren nun Wildcards (*) für Channelnamen. Heissen z.B. alle
203 |        Thermostat-Steuerkanäle "Thermostat <Raum> 1", kann man mit
204 |        SETPARAM "Thermostat * 1" MASTER MODE_TEMPERATUR_REGULATOR 1
205 |        alle gleichzeitig auf Modus "Auto" setzen.
206 | 
207 | V0.6 - Watchdog: Wird nun mehr als 180s kein Callback empfangen, werden die init-Requests erneut
208 |        geschickt (z.B. nach einem Reboot der CCU)
209 |      - Neuer Befehl "HMSet <variable> <wert>" als Shortcut zum Setzen einer HMScript-Variable
210 |      - Neuer Befehl "HMGet <variable1> <variable2...>" als Shortcut zum Lesen einer HMScript-Variable
211 |      - Neuer Befehl "HMRun <programm1> <programm2...>" als Shortcut zum Starten von HMScript-Programmen
212 | 
213 | V0.7 - Mittels "HMGet -timestamp variable" (Textform) oder "HMGet -timestampts variable" (Sekunden seit 1970)
214 |        kann nur die Last-Modification-Timestamp einer Variable abgefragt werden
215 |      - "HMSet" benutzt nun .State(v) statt .Variable(v), damit eventuelle Events auf den Systemvariablen ausgelöst werden
216 |      - Neues Kommando MGET um ein Attribut von einer Menge von Geräten abzufragen, z.B. "MGET PIR* motion". 
217 |        Das Ausgabeformat ist "Gerätename:Wert"
218 | 
219 | V0.8 - Hinweis auf "undokumentierte Schnittstellen" entfernt, da nun durch EQ-3 offengelegt
220 |      - Beim Beenden von HMC wird nun ein de-init an die xmlrpc-Server geschickt
221 |      - Neuer Befehl "STATS" um Statistiken über von den xmlrpc-Servern erhaltene Nachrichten im Cacti-Format zu bekommen
222 |      - QUIT hat nun eine Option "-exit", mit der HMC beendet werden kann
223 |      
224 | V0.9 - Clientverbindungen setzen nun SO_KEEPALIVE
225 |      - REQ unterstützt nun auch die Angabe von Arrays und Strukturen mit der [ Array ] bzw. { key1 value1 key2 value2 }
226 |        Notation
227 |      - GUI-Betriebsmodus zum Setzen der Interface/Roaming-Parameter (einfach ohne Parameter starten)
228 |        
229 | V0.10 - GUI-Modus: Button zum schnellen Refresh der RSSI-Informationen hinzugefügt
230 |       - GUI-Modus: Schnittstellen werden nun in der CCU-Reihenfolge angezeigt, mit dem Default-Interface zuerst
231 |       
232 | V0.11 - GUI-Modus: Buttons zum Setzen aller Devices auf Roaming Off, auf Default == Interface mit dem besten RSSI-Wert
233 |         und Roaming On für alle Fernbedienungen
234 |         
235 | V0.12 - Synchronisationsproblem beim Request-Handling konnte dazu führen, das mehrere schnell hintereinander
236 |         abgesendete "SET" (o.ä.)-Befehle zu einem Deadlock führten
237 |       - Server-Sockets werden nun alle mit SO_REUSEADDR generiert, um schnellen Neustart möglich zu machen
238 |       
239 | V0.13 - Client-Verbindungen benutzen nun unabhängig vom Systemzeichensatz immer UTF-8
240 |         
241 | V0.14 - Optionales Authentifizerungstoken für Client-Verbindungen: Wird HMC mit "homematicip -server 6770 <password>" gestartet,
242 |         werden weitere Befehle nur nach Authentifizerung mit "AUTH <password>" angenommen.
243 |         
244 | V0.15 - Möglichkeit, die lokale IP-Adresse für XML-RPC-Callbacks explizit zu setzen, falls diese falsch ermittelt wird
245 |         (-Dhmc.localhost=192.168.47.11)
246 |          
247 | V0.16 - Neue Option "-state" beim HMGet, um Alarmvariablen korrekt abzufragen (mit obj.State() statt obj.Variable())
248 |               
249 | V0.17 - RSSI GUI: Ist eine Interface-Description gesetzt (geht auf der CCU nur durch manuelle Ergänzung der rfd.conf durch Description=),
250 |         wird diese im Spaltenkopf angezeigt
251 |       - RSSI GUI: Der Checkboxbereich ist nun grün für das Interface, welches die beste Empfangs-RSSI-Werte für das Gerät hat
252 |       - RSSI GUI: Ist das ausgewählte Default-Interface NICHT das mit dem besten RSSI-Empfangs-Wert, wird der Checkbox-Bereich rot dargestellt
253 |       - RSSI GUI: Hinter dem Gerätetyp steht nun die Firmware-Revision
254 | 
255 | V0.18 - unterstützt nun auch CUxD (ab V0.564)
256 |       - Exec-Patch von "sircus" integriert
257 |       - Properties können nun in einer Datei "hmcompanion.cfg" definiert werden
258 |       
259 | V0.19 - experimentelle Funktion zum Setzen von Attributen im GUI-Modus
260 | 
261 | V0.20 - Versionen ab 0.18 starteten nicht mehr korrekt, wenn kein CUxD auf der CCU installiert war.
262 | 
263 | V0.21 - Interface zu Graphite/Carbon hinzugefügt
264 | 
265 | V0.22 - Fix für CCU2 (implement nun system.listMethods)
266 | 
267 | 
268 |     
269 |                                 
270 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                     GNU GENERAL PUBLIC LICENSE
  2 |                        Version 3, 29 June 2007
  3 | 
  4 |  Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
  5 |  Everyone is permitted to copy and distribute verbatim copies
  6 |  of this license document, but changing it is not allowed.
  7 | 
  8 |                             Preamble
  9 | 
 10 |   The GNU General Public License is a free, copyleft license for
 11 | software and other kinds of works.
 12 | 
 13 |   The licenses for most software and other practical works are designed
 14 | to take away your freedom to share and change the works.  By contrast,
 15 | the GNU General Public License is intended to guarantee your freedom to
 16 | share and change all versions of a program--to make sure it remains free
 17 | software for all its users.  We, the Free Software Foundation, use the
 18 | GNU General Public License for most of our software; it applies also to
 19 | any other work released this way by its authors.  You can apply it to
 20 | your programs, too.
 21 | 
 22 |   When we speak of free software, we are referring to freedom, not
 23 | price.  Our General Public Licenses are designed to make sure that you
 24 | have the freedom to distribute copies of free software (and charge for
 25 | them if you wish), that you receive source code or can get it if you
 26 | want it, that you can change the software or use pieces of it in new
 27 | free programs, and that you know you can do these things.
 28 | 
 29 |   To protect your rights, we need to prevent others from denying you
 30 | these rights or asking you to surrender the rights.  Therefore, you have
 31 | certain responsibilities if you distribute copies of the software, or if
 32 | you modify it: responsibilities to respect the freedom of others.
 33 | 
 34 |   For example, if you distribute copies of such a program, whether
 35 | gratis or for a fee, you must pass on to the recipients the same
 36 | freedoms that you received.  You must make sure that they, too, receive
 37 | or can get the source code.  And you must show them these terms so they
 38 | know their rights.
 39 | 
 40 |   Developers that use the GNU GPL protect your rights with two steps:
 41 | (1) assert copyright on the software, and (2) offer you this License
 42 | giving you legal permission to copy, distribute and/or modify it.
 43 | 
 44 |   For the developers' and authors' protection, the GPL clearly explains
 45 | that there is no warranty for this free software.  For both users' and
 46 | authors' sake, the GPL requires that modified versions be marked as
 47 | changed, so that their problems will not be attributed erroneously to
 48 | authors of previous versions.
 49 | 
 50 |   Some devices are designed to deny users access to install or run
 51 | modified versions of the software inside them, although the manufacturer
 52 | can do so.  This is fundamentally incompatible with the aim of
 53 | protecting users' freedom to change the software.  The systematic
 54 | pattern of such abuse occurs in the area of products for individuals to
 55 | use, which is precisely where it is most unacceptable.  Therefore, we
 56 | have designed this version of the GPL to prohibit the practice for those
 57 | products.  If such problems arise substantially in other domains, we
 58 | stand ready to extend this provision to those domains in future versions
 59 | of the GPL, as needed to protect the freedom of users.
 60 | 
 61 |   Finally, every program is threatened constantly by software patents.
 62 | States should not allow patents to restrict development and use of
 63 | software on general-purpose computers, but in those that do, we wish to
 64 | avoid the special danger that patents applied to a free program could
 65 | make it effectively proprietary.  To prevent this, the GPL assures that
 66 | patents cannot be used to render the program non-free.
 67 | 
 68 |   The precise terms and conditions for copying, distribution and
 69 | modification follow.
 70 | 
 71 |                        TERMS AND CONDITIONS
 72 | 
 73 |   0. Definitions.
 74 | 
 75 |   "This License" refers to version 3 of the GNU General Public License.
 76 | 
 77 |   "Copyright" also means copyright-like laws that apply to other kinds of
 78 | works, such as semiconductor masks.
 79 | 
 80 |   "The Program" refers to any copyrightable work licensed under this
 81 | License.  Each licensee is addressed as "you".  "Licensees" and
 82 | "recipients" may be individuals or organizations.
 83 | 
 84 |   To "modify" a work means to copy from or adapt all or part of the work
 85 | in a fashion requiring copyright permission, other than the making of an
 86 | exact copy.  The resulting work is called a "modified version" of the
 87 | earlier work or a work "based on" the earlier work.
 88 | 
 89 |   A "covered work" means either the unmodified Program or a work based
 90 | on the Program.
 91 | 
 92 |   To "propagate" a work means to do anything with it that, without
 93 | permission, would make you directly or secondarily liable for
 94 | infringement under applicable copyright law, except executing it on a
 95 | computer or modifying a private copy.  Propagation includes copying,
 96 | distribution (with or without modification), making available to the
 97 | public, and in some countries other activities as well.
 98 | 
 99 |   To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies.  Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 | 
103 |   An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License.  If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 | 
112 |   1. Source Code.
113 | 
114 |   The "source code" for a work means the preferred form of the work
115 | for making modifications to it.  "Object code" means any non-source
116 | form of a work.
117 | 
118 |   A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 | 
123 |   The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form.  A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 | 
134 |   The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities.  However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work.  For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 | 
147 |   The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 | 
151 |   The Corresponding Source for a work in source code form is that
152 | same work.
153 | 
154 |   2. Basic Permissions.
155 | 
156 |   All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met.  This License explicitly affirms your unlimited
159 | permission to run the unmodified Program.  The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work.  This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 | 
164 |   You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force.  You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright.  Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 | 
175 |   Conveying under any other circumstances is permitted solely under
176 | the conditions stated below.  Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 | 
179 |   3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 | 
181 |   No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 | 
187 |   When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 | 
195 |   4. Conveying Verbatim Copies.
196 | 
197 |   You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 | 
205 |   You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 | 
208 |   5. Conveying Modified Source Versions.
209 | 
210 |   You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 | 
214 |     a) The work must carry prominent notices stating that you modified
215 |     it, and giving a relevant date.
216 | 
217 |     b) The work must carry prominent notices stating that it is
218 |     released under this License and any conditions added under section
219 |     7.  This requirement modifies the requirement in section 4 to
220 |     "keep intact all notices".
221 | 
222 |     c) You must license the entire work, as a whole, under this
223 |     License to anyone who comes into possession of a copy.  This
224 |     License will therefore apply, along with any applicable section 7
225 |     additional terms, to the whole of the work, and all its parts,
226 |     regardless of how they are packaged.  This License gives no
227 |     permission to license the work in any other way, but it does not
228 |     invalidate such permission if you have separately received it.
229 | 
230 |     d) If the work has interactive user interfaces, each must display
231 |     Appropriate Legal Notices; however, if the Program has interactive
232 |     interfaces that do not display Appropriate Legal Notices, your
233 |     work need not make them do so.
234 | 
235 |   A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit.  Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 | 
245 |   6. Conveying Non-Source Forms.
246 | 
247 |   You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 | 
252 |     a) Convey the object code in, or embodied in, a physical product
253 |     (including a physical distribution medium), accompanied by the
254 |     Corresponding Source fixed on a durable physical medium
255 |     customarily used for software interchange.
256 | 
257 |     b) Convey the object code in, or embodied in, a physical product
258 |     (including a physical distribution medium), accompanied by a
259 |     written offer, valid for at least three years and valid for as
260 |     long as you offer spare parts or customer support for that product
261 |     model, to give anyone who possesses the object code either (1) a
262 |     copy of the Corresponding Source for all the software in the
263 |     product that is covered by this License, on a durable physical
264 |     medium customarily used for software interchange, for a price no
265 |     more than your reasonable cost of physically performing this
266 |     conveying of source, or (2) access to copy the
267 |     Corresponding Source from a network server at no charge.
268 | 
269 |     c) Convey individual copies of the object code with a copy of the
270 |     written offer to provide the Corresponding Source.  This
271 |     alternative is allowed only occasionally and noncommercially, and
272 |     only if you received the object code with such an offer, in accord
273 |     with subsection 6b.
274 | 
275 |     d) Convey the object code by offering access from a designated
276 |     place (gratis or for a charge), and offer equivalent access to the
277 |     Corresponding Source in the same way through the same place at no
278 |     further charge.  You need not require recipients to copy the
279 |     Corresponding Source along with the object code.  If the place to
280 |     copy the object code is a network server, the Corresponding Source
281 |     may be on a different server (operated by you or a third party)
282 |     that supports equivalent copying facilities, provided you maintain
283 |     clear directions next to the object code saying where to find the
284 |     Corresponding Source.  Regardless of what server hosts the
285 |     Corresponding Source, you remain obligated to ensure that it is
286 |     available for as long as needed to satisfy these requirements.
287 | 
288 |     e) Convey the object code using peer-to-peer transmission, provided
289 |     you inform other peers where the object code and Corresponding
290 |     Source of the work are being offered to the general public at no
291 |     charge under subsection 6d.
292 | 
293 |   A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 | 
297 |   A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling.  In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage.  For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product.  A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 | 
310 |   "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source.  The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 | 
318 |   If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information.  But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 | 
329 |   The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed.  Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 | 
337 |   Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 | 
343 |   7. Additional Terms.
344 | 
345 |   "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law.  If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 | 
354 |   When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it.  (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.)  You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 | 
361 |   Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 | 
365 |     a) Disclaiming warranty or limiting liability differently from the
366 |     terms of sections 15 and 16 of this License; or
367 | 
368 |     b) Requiring preservation of specified reasonable legal notices or
369 |     author attributions in that material or in the Appropriate Legal
370 |     Notices displayed by works containing it; or
371 | 
372 |     c) Prohibiting misrepresentation of the origin of that material, or
373 |     requiring that modified versions of such material be marked in
374 |     reasonable ways as different from the original version; or
375 | 
376 |     d) Limiting the use for publicity purposes of names of licensors or
377 |     authors of the material; or
378 | 
379 |     e) Declining to grant rights under trademark law for use of some
380 |     trade names, trademarks, or service marks; or
381 | 
382 |     f) Requiring indemnification of licensors and authors of that
383 |     material by anyone who conveys the material (or modified versions of
384 |     it) with contractual assumptions of liability to the recipient, for
385 |     any liability that these contractual assumptions directly impose on
386 |     those licensors and authors.
387 | 
388 |   All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10.  If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term.  If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 | 
398 |   If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 | 
403 |   Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 | 
407 |   8. Termination.
408 | 
409 |   You may not propagate or modify a covered work except as expressly
410 | provided under this License.  Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 | 
415 |   However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 | 
422 |   Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 | 
429 |   Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License.  If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 | 
435 |   9. Acceptance Not Required for Having Copies.
436 | 
437 |   You are not required to accept this License in order to receive or
438 | run a copy of the Program.  Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance.  However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work.  These actions infringe copyright if you do
443 | not accept this License.  Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 | 
446 |   10. Automatic Licensing of Downstream Recipients.
447 | 
448 |   Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License.  You are not responsible
451 | for enforcing compliance by third parties with this License.
452 | 
453 |   An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations.  If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 | 
463 |   You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License.  For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 | 
471 |   11. Patents.
472 | 
473 |   A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based.  The
475 | work thus licensed is called the contributor's "contributor version".
476 | 
477 |   A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version.  For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 | 
487 |   Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 | 
492 |   In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement).  To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 | 
499 |   If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients.  "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 | 
513 |   If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 | 
521 |   A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License.  You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 | 
536 |   Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 | 
540 |   12. No Surrender of Others' Freedom.
541 | 
542 |   If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License.  If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all.  For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 | 
552 |   13. Use with the GNU Affero General Public License.
553 | 
554 |   Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work.  The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 | 
563 |   14. Revised Versions of this License.
564 | 
565 |   The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time.  Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 | 
570 |   Each version is given a distinguishing version number.  If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation.  If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 | 
579 |   If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 | 
584 |   Later license versions may give you additional or different
585 | permissions.  However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 | 
589 |   15. Disclaimer of Warranty.
590 | 
591 |   THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 | 
600 |   16. Limitation of Liability.
601 | 
602 |   IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 | 
612 |   17. Interpretation of Sections 15 and 16.
613 | 
614 |   If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 | 
621 |                      END OF TERMS AND CONDITIONS
622 | 
623 |             How to Apply These Terms to Your New Programs
624 | 
625 |   If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 | 
629 |   To do so, attach the following notices to the program.  It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 | 
634 |     {one line to give the program's name and a brief idea of what it does.}
635 |     Copyright (C) {year}  {name of author}
636 | 
637 |     This program is free software: you can redistribute it and/or modify
638 |     it under the terms of the GNU General Public License as published by
639 |     the Free Software Foundation, either version 3 of the License, or
640 |     (at your option) any later version.
641 | 
642 |     This program is distributed in the hope that it will be useful,
643 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
644 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
645 |     GNU General Public License for more details.
646 | 
647 |     You should have received a copy of the GNU General Public License
648 |     along with this program.  If not, see <http://www.gnu.org/licenses/>.
649 | 
650 | Also add information on how to contact you by electronic and paper mail.
651 | 
652 |   If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 | 
655 |     {project}  Copyright (C) {year}  {fullname}
656 |     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 |     This is free software, and you are welcome to redistribute it
658 |     under certain conditions; type `show c' for details.
659 | 
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License.  Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 | 
664 |   You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | <http://www.gnu.org/licenses/>.
668 | 
669 |   The GNU General Public License does not permit incorporating your program
670 | into proprietary programs.  If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library.  If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License.  But first, please read
674 | <http://www.gnu.org/philosophy/why-not-lgpl.html>.
675 | 


--------------------------------------------------------------------------------