An implementation of the FLL Score Client Protocol in Javascript.
This module is intended to be used with the FLL Scoring Software Only! Using this with another system is not supported
$ npm install fllscoreclientThe FLL Scoring Software includes a public API for clients to connect and receive scoring info. The software communicates with clients through a TCP socket connection. This package provides the following objects to connect:
- A local client that can perform all actions of the protocol (requires node.js to run).
- A Web client on the browser that can receive scoring info as new data is available.*
*The Web client requires a proxy server to run as raw tcp sockets are not available on the browser.
See the API section below for more info on each object
(Requires a WebProxy to be running as well, see instructions below)
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Title</title>
<script src="https://unpkg.com/fllscoreclient@latest/dist/fllscoreclient.js"></script>
<script>
var client = fllscoreclient.createWebClient('0.0.0.0', 8101);
// Listen to events and handle updates immediately!
client.on('lastUpdate', (date) => {
console.log(date);
});
client.on('scoreInfo', (info) => {
console.log(info);
});
// Request data on demand!
client.getLastUpdate().then((date) => {
console.log(date);
}).catch((err) => {
console.error(err);
});
client.getScoreInfo().then((info) => {
console.log(info);
}).catch((err) => {
console.error(err);
});
</script>
</head>
<body>
Check the console...
</body>
</html>var fllScoreProxy = require('fllscoreclient/dist/fllscoreclientproxy');
var proxy = fllScoreProxy.createWebProxy({
servePort: 8101,
infoPollingRate: 3,
socketOpts: {
host: 'localhost',
port: 8100
}
});
proxy.startProxy().then((res) => {
if (res) {
console.log('Server Started...');
} else {
console.log('Server Unable to Start... try again');
}
});var fllScoreProxy = require('fllscoreclient/dist/fllscoreclientproxy');
var client = fllScoreProxy.createClient({host: 'localhost', port: 8100});
client.connect().then(function(res) {
console.log(res);
return client.sendPing();
}).then(function(res) {
console.log(res);
return client.sendLastUpdate();
}).then(function(res) {
if (res) {
console.log('Update is necessary');
} else {
console.log('No Update Needed');
}
console.log(client.lastUpdate.toISOString());
return new Promise(function (resolve) {
setTimeout(resolve, 5000);
});
}).then(function() {
return client.sendScore();
}).then(function(res) {
console.log(JSON.stringify(res));
return client.sendLastUpdate();
}).then(function(res) {
if (res) {
console.log('Update is necessary');
} else {
console.log('No Update Needed');
}
console.log(client.lastUpdate.toISOString());
return client.close();
}).then(function(res) {
console.log(res);
}).catch(function(err) {
console.log('Rejected: ' + err.message);
});Examples can be run after checkout by running npm install and starting the mock server
$ cd example/
### In one window (mock scoring program)
$ python server.py
### Run local client
$ node test.js
### In another window (start proxy, then open webTest.html)
$ node webProxy.jsIncoming...
The full documentation is available in the docs folder here