Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/glitchdotcom/solari-board
A JavaScript solari board
https://github.com/glitchdotcom/solari-board
Last synced: 6 days ago
JSON representation
A JavaScript solari board
- Host: GitHub
- URL: https://github.com/glitchdotcom/solari-board
- Owner: glitchdotcom
- License: mit
- Created: 2013-08-02T18:50:49.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2017-05-18T13:35:44.000Z (over 7 years ago)
- Last Synced: 2024-08-01T19:42:49.414Z (3 months ago)
- Language: JavaScript
- Size: 286 KB
- Stars: 129
- Watchers: 19
- Forks: 29
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Solari Board
Fog Creek has used its [Big Board](http://blog.fogcreek.com/big-board-having-fun-with-data/)
for close to three years...and now you can have your own!
The Solari Board jQuery application will accept JSON from any source. The support team at Fog Creek
feeds in tech call information from FogBugz, but the possibilities are limitless!
The application expects a JSON array wrapped in a function call ([JSONP](http://en.wikipedia.org/wiki/JSONP)) and filled with objects that have the
following properties:
* `sDate`: the day of the appointment. The Solari board can handle values
like `yesterday` or `today`.
* `sTime`: the time of the appointment. Format like `22:45` and remember the leading zero
on the hours. If this appointment does not have a time, make it an empty string.
* `sDeparture`: an arbitrary string; on our board, it's the email address of
the support technition who has the support call.
* `nStatus`: allows you to set the status to one of four statuses: "All Aboard" (`nStatus
= 1`), "On Time" (`nStatus = 2`), "Delayed" (`nStatus = 3`) or "Departed"(`nStatus = 4`).
* `nTrack`: an arbitrary integer between 0 and 99; we use it to indicate
which extension the call should be on, but you can use it for whatever
purpose you want.
* `fLight`: should be set to `true` if you want the lightbulb by that row
illuminated, and `false` otherwise.
Here's an example:
jsonpCallback(
[
{'sDate': 'today',
'sTime': '13:30',
'sDeparture': '[email protected]',
'nStatus': 1,
'nTrack': 17,
'fLight': true
},
{'sDate': 'yesterday',
'sTime': '16:00',
'sDeparture': '[email protected]',
'nStatus': 2,
'nTrack': 19,
'fLight':false
},
{'sDate': 'July 8th, 2013',
'sTime': '16:30',
'sDeparture': '[email protected]',
'nStatus': 2,
'nTrack': 23,
'fLight':false
}
]
)
# How do I use it?
It's simple!
1. Include the following lines in your HTML:
Your browser does not support the audio element.
2. Add the following script to your webpage's head:
$(document).ready(function() {
//remove the div parameter to append directly to body
addSolariBoard("#myDIv");
});
3. Point the board to the script that will feed it jsonp
$.post('../example/postJson.py') // replace this with your own script
Currently, Google Chrome and Internet Explorer are the only supported browsers.
This is due to an issue in animating the CSS property `backgroundPositionY` on
other browsers. We'd welcome patches that help resolve this issue.
## Additional Configuration and Examples
- Toggle `status_override` in `solari.js` to have the board automatically change the
status column using time and date due.
- The `sDate` field takes any
[date.js](https://code.google.com/p/datejs/wiki/APIDocumentation#parse) parsable string
(e.g. `today`, `next monday`)
- There are two included examples, postJsonp.py is a basic script that statically sends the sample payload given above to the solari board.
postFogbugz.py connects to a FogBugz installation through the [xml api](https://developers.fogbugz.com/default.asp?W199).
To use either example, Just place all files and folders onto a Python-enabled CGI server, then edit `fbsettings.py` with your FogBugz URL and
[FogBugz token](http://fogbugz.stackexchange.com/questions/900/how-do-i-get-an-xml-api-token) if needed.
## Copyright
Copyright © 2013 Fog Creek Software, Inc. All rights reserved.
### Licensing
The Solari Board is licensed under the [MIT](http://opensource.org/licenses/mit-license.php) license.