Main.Documentation.Bundles
BluetoothServer
en
0
Main.Documentation.Bundles
xwiki:XWiki.donsez
xwiki:XWiki.calmant
xwiki:XWiki.calmant
1276181341000
1282852311000
1282852311000
1.10
Aspire :: OSGi Bundles :: Bluetooth Server
1 Aspire :: OSGi Bundles :: Bluetooth Server
----
#toc("" "" "true")
----
1.1 Goal
This bundle provides a multi-client bluetooth server.
It provides a BluetoothServerService service when activated, and must be configured before being the server really starts.
It uses the [Bluecove JSR82 implementation>http://bluecove.org], so all the device configuration may be done by setting Java system properties (see [the bluecove documentation>http://code.google.com/p/bluecove/wiki/Documentation]).
The server waits for a new client via a blocking call, so run it in a specific thread.
Each client is run in a thread, due to blocking InputStream calls.
1.1 Sample usage
1.1.1 How to start the server
{code}
// Read properties and threads
BluetoothServerService m_server = new BluetoothServerImpl();
// Set the device discoverable
m_server.prepareServer();
// Start listening in a special thread
m_server.startServer();
{code}
1.1.1 How to stop the server
{code}
m_server.stop();
{code}
1.1.1 How to configure the server
The server can be configured via a property XML file, given as an InputStream parameter to the prepareServer() method.
Sample : Read a configuration XML file embedded in the bundle JAR file.
{code}
m_server.prepareServer(getClass().getResourceAsStream("/bluetoothConfig.xml"));
{code}
Parameters :
{table}
Key|Type|Description|Default
uuid|String|Server's "Universally" Unique IDentifier|
serviceName|String|Server's name|
authenticate|boolean|Server needs client authentification|false
encrypt|boolean|Communication must be encrypted|false
inquiryMode|int|Type of inquiries to respond to (GIAC or LIAC) (see http://bluecove.org/bluecove/apidocs/javax/bluetooth/DiscoveryAgent.html)|GIAC
debug|boolean|Verbose mode|false
readingMode|BYTE, CHAR or UTF|Which DataInputStream reading method must be used (readByte, readChar or readUTF)|CHAR
max_threads|int|Maximum number of communication threads (not used)|
{table}
1.1.1 How to read data from devices
This bundle use a listener model : each class who needs to read communication data must implement the CommunicationListener interface.
This interface provides three functions :
* commBegin(String logicalName) : Called when a client has just connected the server, logicalName is UUID generated by the server to identify a connection
* commEnd(String logicalName) : Called when a client has ended the connection, or when the server stops.
* commRead(String logicalName, String data) : Called when the server read a line from the client.
The logical name is the client unique identifier, based on its Bluetooth address and its friendly name (if present).
{code}
class BluetoothComm implements CommunicationListener {
private BluetoothServerService m_server;
public BluetoothComm()
m_server = new BluetoothServerImpl();
m_server.prepareServer(getClass().getResourceAsStream("/bluetoothConfig.xml"));
m_server.startServer();
m_server.addCommunicationListener(this);
}
public void commBegin(String logicalName) {
System.out.println("Client connected : " + logicalName);
}
public void commEnd(String logicalName) {
System.out.println("Client gone : " + logicalName);
}
public void commRead(String logicalName, String data) {
System.out.println("Read '" + data + "' from " + logicalName);
// Write some data in response
try {
m_server.getCommunication(logicalName).writeData("ACK\n");
}
catch (IOException e) {
// Error occurred during write process
}
}
}
{code}
1.1 Issues under Linux
1.1.1 License issue
* For latest versions BlueZ (v4 and higher), this bundle needs bluecove-gpl library to work, under GPL.
* For older versions, it *may* be possible to use bluecove-bluez instead, under Apache License 2.0 (*not tested*).
1.1.1 Rights issue
This bundle needs to have root rights in order to set the device discoverable.
A solution to bypass this problem is to set the device discoverable in system wide configuration.
(It can be done with user rights with gnome-bluetooth, for example).
1.1 Test
1.1.1 Operating systems
* Windows
** Windows 7, 32 bits version
* Linux
** Fedora 13, 64 bits version, with bluecove-gpl
1.1.1 Dongles
* Built-in AsusTEK bluetooth device, with generic drivers
1.1 Hints for future improvements
* Control the number of client threads, by aggregating them in a thread pool.
<h2 class="heading-1"><span id="HAspire3A3AOSGiBundles3A3ABluetoothServer">Aspire :: OSGi Bundles :: Bluetooth Server</span></h2><p class="paragraph"/><hr class="line"/>
<ul>
<li><a href="#HGoal">1 Goal</a>
<li><a href="#HSampleusage">2 Sample usage</a>
<ul>
<li><a href="#HHowtostarttheserver">2.1 How to start the server</a>
<li><a href="#HHowtostoptheserver">2.2 How to stop the server</a>
<li><a href="#HHowtoconfiguretheserver">2.3 How to configure the server</a>
<li><a href="#HHowtoreaddatafromdevices">2.4 How to read data from devices</a>
</ul>
<li><a href="#HIssuesunderLinux">3 Issues under Linux</a>
<ul>
<li><a href="#HLicenseissue">3.1 License issue</a>
<li><a href="#HRightsissue">3.2 Rights issue</a>
</ul>
<li><a href="#HTest">4 Test</a>
<ul>
<li><a href="#HOperatingsystems">4.1 Operating systems</a>
<li><a href="#HDongles">4.2 Dongles</a>
</ul>
<li><a href="#HHintsforfutureimprovements">5 Hints for future improvements</a>
</ul> <hr class="line"/>
<h3 class="heading-1-1"><span id="HGoal">Goal</span></h3><p class="paragraph"/>This bundle provides a multi-client bluetooth server.
It provides a BluetoothServerService service when activated, and must be configured before being the server really starts.<p class="paragraph"/>It uses the <span class="wikiexternallink"><a href="http://bluecove.org">Bluecove JSR82 implementation</a></span>, so all the device configuration may be done by setting Java system properties (see <span class="wikiexternallink"><a href="http://code.google.com/p/bluecove/wiki/Documentation">the bluecove documentation</a></span>).<p class="paragraph"/>The server waits for a new client via a blocking call, so run it in a specific thread.
Each client is run in a thread, due to blocking InputStream calls.
<h3 class="heading-1-1"><span id="HSampleusage">Sample usage</span></h3>
<h4 class="heading-1-1-1"><span id="HHowtostarttheserver">How to start the server</span></h4><p class="paragraph"/><div class="code"><pre>// Read properties and threads
BluetoothServerService m_server = <span class="java-keyword">new</span> BluetoothServerImpl();<p class="paragraph"/>// Set the device discoverable
m_server.prepareServer();<p class="paragraph"/>// Start listening in a special thread
m_server.startServer();</pre></div>
<h4 class="heading-1-1-1"><span id="HHowtostoptheserver">How to stop the server</span></h4><p class="paragraph"/><div class="code"><pre>m_server.stop();</pre></div>
<h4 class="heading-1-1-1"><span id="HHowtoconfiguretheserver">How to configure the server</span></h4><p class="paragraph"/>The server can be configured via a property XML file, given as an InputStream parameter to the prepareServer() method.<p class="paragraph"/>Sample : Read a configuration XML file embedded in the bundle JAR file.<p class="paragraph"/><div class="code"><pre>m_server.prepareServer(getClass().getResourceAsStream(<span class="java-quote">"/bluetoothConfig.xml"</span>));</pre></div><p class="paragraph"/>Parameters :<p class="paragraph"/><table class="wiki-table" cellpadding="0" cellspacing="0" border="0"><tr><th>Key</th><th>Type</th><th>Description</th><th>Default</th></tr><tr class="table-odd"><td>uuid</td><td>String</td><td>Server's "Universally" Unique IDentifier</td><td> </td></tr><tr class="table-even"><td>serviceName</td><td>String</td><td>Server's name</td><td> </td></tr><tr class="table-odd"><td>authenticate</td><td>boolean</td><td>Server needs client authentification</td><td>false</td></tr><tr class="table-even"><td>encrypt</td><td>boolean</td><td>Communication must be encrypted</td><td>false</td></tr><tr class="table-odd"><td>inquiryMode</td><td>int</td><td>Type of inquiries to respond to (GIAC or LIAC) (see <span class="nobr"><a href="http://bluecove.org/bluecove/apidocs/javax/bluetooth/DiscoveryAgent.html">http://bluecove.org/bluecove/apidocs/javax/bluetooth/DiscoveryAgent.html</a></span>)</td><td>GIAC</td></tr><tr class="table-even"><td>debug</td><td>boolean</td><td>Verbose mode</td><td>false</td></tr><tr class="table-odd"><td>readingMode</td><td>BYTE, CHAR or UTF</td><td>Which DataInputStream reading method must be used (readByte, readChar or readUTF)</td><td>CHAR</td></tr><tr class="table-even"><td>max_threads</td><td>int</td><td>Maximum number of communication threads (not used)</td><td> </td></tr></table>
<h4 class="heading-1-1-1"><span id="HHowtoreaddatafromdevices">How to read data from devices</span></h4><p class="paragraph"/>This bundle use a listener model : each class who needs to read communication data must implement the CommunicationListener interface.<p class="paragraph"/>This interface provides three functions :
<ul class="star">
<li>commBegin(String logicalName) : Called when a client has just connected the server, logicalName is UUID generated by the server to identify a connection</li>
<li>commEnd(String logicalName) : Called when a client has ended the connection, or when the server stops.</li>
<li>commRead(String logicalName, String data) : Called when the server read a line from the client.</li>
</ul>The logical name is the client unique identifier, based on its Bluetooth address and its friendly name (if present).<p class="paragraph"/><div class="code"><pre>class BluetoothComm <span class="java-keyword">implements</span> CommunicationListener {
<span class="java-keyword">private</span> BluetoothServerService m_server;<p class="paragraph"/> <span class="java-keyword">public</span> BluetoothComm()
m_server = <span class="java-keyword">new</span> BluetoothServerImpl();
m_server.prepareServer(getClass().getResourceAsStream(<span class="java-quote">"/bluetoothConfig.xml"</span>));
m_server.startServer();
m_server.addCommunicationListener(<span class="java-keyword">this</span>);
}<p class="paragraph"/> <span class="java-keyword">public</span> void commBegin(<span class="java-object">String</span> logicalName) {
<span class="java-object">System</span>.out.println(<span class="java-quote">"Client connected : "</span> + logicalName);
}<p class="paragraph"/> <span class="java-keyword">public</span> void commEnd(<span class="java-object">String</span> logicalName) {
<span class="java-object">System</span>.out.println(<span class="java-quote">"Client gone : "</span> + logicalName);
}<p class="paragraph"/> <span class="java-keyword">public</span> void commRead(<span class="java-object">String</span> logicalName, <span class="java-object">String</span> data) {
<span class="java-object">System</span>.out.println(<span class="java-quote">"Read '"</span> + data + <span class="java-quote">"' from "</span> + logicalName);<p class="paragraph"/> // Write some data in response
<span class="java-keyword">try</span> {
m_server.getCommunication(logicalName).writeData(<span class="java-quote">"ACKn"</span>);
}
<span class="java-keyword">catch</span> (IOException e) {
// Error occurred during write process
}
}
}</pre></div>
<h3 class="heading-1-1"><span id="HIssuesunderLinux">Issues under Linux</span></h3>
<h4 class="heading-1-1-1"><span id="HLicenseissue">License issue</span></h4>
<ul class="star">
<li>For latest versions BlueZ (v4 and higher), this bundle needs bluecove-gpl library to work, under GPL.</li>
<li>For older versions, it <strong class="strong">may</strong> be possible to use bluecove-bluez instead, under Apache License 2.0 (<strong class="strong">not tested</strong>).</li>
</ul><h4 class="heading-1-1-1"><span id="HRightsissue">Rights issue</span></h4><p class="paragraph"/>This bundle needs to have root rights in order to set the device discoverable.<p class="paragraph"/>A solution to bypass this problem is to set the device discoverable in system wide configuration.
(It can be done with user rights with gnome-bluetooth, for example).
<h3 class="heading-1-1"><span id="HTest">Test</span></h3>
<h4 class="heading-1-1-1"><span id="HOperatingsystems">Operating systems</span></h4>
<ul class="star">
<li>Windows<ul class="star">
<li>Windows 7, 32 bits version</li>
</ul>
</li>
<li>Linux<ul class="star">
<li>Fedora 13, 64 bits version, with bluecove-gpl</li>
</ul></li>
</ul><h4 class="heading-1-1-1"><span id="HDongles">Dongles</span></h4>
<ul class="star">
<li>Built-in AsusTEK bluetooth device, with generic drivers</li>
</ul><h3 class="heading-1-1"><span id="HHintsforfutureimprovements">Hints for future improvements</span></h3>
<ul class="star">
<li>Control the number of client threads, by aggregating them in a thread pool.</li>
</ul>