Skip to content

Latest commit

 

History

History
163 lines (110 loc) · 7.18 KB

README.md

File metadata and controls

163 lines (110 loc) · 7.18 KB
Raw

charlotte

charlotte spins a hyperlocal context graph and digital twins into a web visualisation using Cytoscape.js.

Overview of charlotte.js

charlotte is lightweight client-side JavaScript that runs in the browser. See a live demo using the code in this repository at: reelyactive.github.io/charlotte/?demo=default

Hello charlotte!

Include in an index.html file the viewport, charlotte.js script and Cytoscape dependencies:

<html>
  <head></head>
  <body>
    <div id="cy-container">
      <div id="cy" class="w-100 h-100"></div>
    </div>
    <script src="js/cytoscape.min.js"></script>
    <script src="js/layout-base.js"></script>
    <script src="js/cose-base.js"></script>
    <script src="js/cytoscape-fcose.js"></script>
    <script src="js/charlotte.js"></script>
    <script src="js/app.js"></script>
  </body>
</html>

Include in a js/app.js the code to initialise and spin the web of devices:

let target = document.getElementById('cy');
let digitalTwins = new Map(); // Or use cormorant.digitalTwins (see below)
let devices = new Map();      // Or use beaver.devices (see below)
let options = {};             // See Options section below
charlotte.init(target, { digitalTwins: digitalTwins });
charlotte.on('tap', (nodeId) => { /* Handle tap of node in graph */ });

charlotte.spin(devices, target, options);

Open the index.html file in a web browser for charlotte to render the web of devices as a fCoSE graph.

Developing web apps with beaver, cormorant & charlotte

Developing web apps using the Pareto Anywhere APIs is straightforward with beaver, cormorant and charlotte.

Include in an index.html file the viewport, charlotte.js script and dependencies:

<html>
  <head></head>
  <body>
    <div id="cy-container">
      <div id="cy" class="w-100 h-100"></div>
    </div>
    <script src="js/cytoscape.min.js"></script>
    <script src="js/layout-base.js"></script>
    <script src="js/cose-base.js"></script>
    <script src="js/cytoscape-fcose.js"></script>
    <script src="js/cormorant.js"></script>
    <script src="js/beaver.js"></script>
    <script src="js/charlotte.js"></script>
    <script src="js/app.js"></script>
  </body>
</html>

Include in a js/app.js the code to poll the hyperlocal context, retrieve any digital twins, and spin the web of devices:

let target = document.getElementById('cy');

charlotte.init(target, { digitalTwins: cormorant.digitalTwins });
charlotte.on('tap', (nodeId) => { /* Handle tap of node in graph */ });

charlotte.spin(beaver.devices, target, {});

Options

charlotte supports the following options for the spin function:

{
  filters: { minRSSI: -100 }
}

For instance, to spin the web of devices with signal strength (RSSI) > 70 dBm, use the following options:

charlotte.spin(devices, target, { filters: { minRSSI: -70 } });

charlotte logo

What's in a name?

In the classic children's story Charlotte's Web, Charlotte is a barn spider who communicates human-readable information through the webs she spins. Her webs ultimately influence decisions that change the life of "some pig" for the better.

While in the story, Charlotte spins words into her webs, in her client-side habitat, charlotte.js will spin graphs that allow humans to visualise real-time physical and semantic relationships between people, places and things. Her "humble" hope is that the webs she spins in your browser will positively influence data-based decision-making, so that you don't have to rely on your spidey senses alone!

As in the story, charlotte.js can't do it all by herself. She uses Cytoscape.js to help her with the graphs themselves, while her unlikely client-side barnyard companions—beaver, cormorant and the "radiant" cuttlefish—collect and prepare the source data.

Speaking of barnyard companions, charlotte.js is actually our second barn-themed mascot after barnowl. Hay, isn't that "terrific"!

Acknowledgements

charlotte uses Cytoscape.js which was created at the University of Toronto and published in Oxford Bioinformatics (2016, 2023), and the cytoscape.js-fcose fCoSE layout algorithm extension developed by the iVis Lab at Bilkent University. We extend our thanks to the developers of these open source projects.

Modular Architecture

charlotte.js is easily combined with the following complementary client-side modules:

Learn more about the reelyActive Open Source Software packages, all of which are bundled together as Pareto Anywhere open source IoT middleware.

Contributing

Discover how to contribute to this open source project which upholds a standard code of conduct.

Security

Consult our security policy for best practices using this open source software and to report vulnerabilities.

License

MIT License

Copyright (c) 2021-2024 reelyActive

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.