{"id":22859943,"url":"https://github.com/reelyactive/charlotte","last_synced_at":"2025-10-09T04:04:21.598Z","repository":{"id":69136619,"uuid":"382132775","full_name":"reelyactive/charlotte","owner":"reelyactive","description":"Spin physical web and semantic web visualisations using Cytoscape.js.  We believe in an open Internet of Things.","archived":false,"fork":false,"pushed_at":"2024-12-11T00:01:20.000Z","size":763,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-10-09T04:03:45.804Z","etag":null,"topics":["client-side","cytoscapejs","fcose","iot","physical-web","rtls","semantic-web"],"latest_commit_sha":null,"homepage":"https://reelyactive.github.io/charlotte/?demo=default","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/reelyactive.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-07-01T19:11:48.000Z","updated_at":"2024-12-11T00:01:24.000Z","dependencies_parsed_at":null,"dependency_job_id":"a2251494-3dd3-4693-9f8a-8ce25924f2fd","html_url":"https://github.com/reelyactive/charlotte","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/reelyactive/charlotte","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reelyactive%2Fcharlotte","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reelyactive%2Fcharlotte/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reelyactive%2Fcharlotte/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reelyactive%2Fcharlotte/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/reelyactive","download_url":"https://codeload.github.com/reelyactive/charlotte/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reelyactive%2Fcharlotte/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279000755,"owners_count":26082921,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-09T02:00:07.460Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["client-side","cytoscapejs","fcose","iot","physical-web","rtls","semantic-web"],"created_at":"2024-12-13T09:08:30.006Z","updated_at":"2025-10-09T04:04:21.567Z","avatar_url":"https://github.com/reelyactive.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"charlotte\n=========\n\n__charlotte__ spins a [hyperlocal context](https://www.reelyactive.com/context/) graph and digital twins into a web visualisation using Cytoscape.js.\n\n![Overview of charlotte.js](https://reelyactive.github.io/charlotte/images/overview.png)\n\n__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](https://reelyactive.github.io/charlotte/?demo=default)\n\n\nHello charlotte!\n----------------\n\nInclude in an _index.html_ file the viewport, __charlotte.js__ script and Cytoscape dependencies:\n\n```html\n\u003chtml\u003e\n  \u003chead\u003e\u003c/head\u003e\n  \u003cbody\u003e\n    \u003cdiv id=\"cy-container\"\u003e\n      \u003cdiv id=\"cy\" class=\"w-100 h-100\"\u003e\u003c/div\u003e\n    \u003c/div\u003e\n    \u003cscript src=\"js/cytoscape.min.js\"\u003e\u003c/script\u003e\n    \u003cscript src=\"js/layout-base.js\"\u003e\u003c/script\u003e\n    \u003cscript src=\"js/cose-base.js\"\u003e\u003c/script\u003e\n    \u003cscript src=\"js/cytoscape-fcose.js\"\u003e\u003c/script\u003e\n    \u003cscript src=\"js/charlotte.js\"\u003e\u003c/script\u003e\n    \u003cscript src=\"js/app.js\"\u003e\u003c/script\u003e\n  \u003c/body\u003e\n\u003c/html\u003e\n```\n\nInclude in a _js/app.js_ the code to initialise and spin the web of devices:\n\n```javascript\nlet target = document.getElementById('cy');\nlet digitalTwins = new Map(); // Or use cormorant.digitalTwins (see below)\nlet devices = new Map();      // Or use beaver.devices (see below)\nlet options = {};             // See Options section below\ncharlotte.init(target, { digitalTwins: digitalTwins });\ncharlotte.on('tap', (nodeId) =\u003e { /* Handle tap of node in graph */ });\n\ncharlotte.spin(devices, target, options);\n```\n\nOpen the _index.html_ file in a web browser for __charlotte__ to render the web of devices as a fCoSE graph.\n\n\nDeveloping web apps with beaver, cormorant \u0026 charlotte\n------------------------------------------------------\n\nDeveloping web apps using the [Pareto Anywhere](https://www.reelyactive.com/pareto/anywhere/) APIs is straightforward with [beaver](https://github.com/reelyactive/beaver), [cormorant](https://github.com/reelyactive/cormorant/) and __charlotte__.\n\nInclude in an _index.html_ file the viewport, __charlotte.js__ script and dependencies:\n\n```html\n\u003chtml\u003e\n  \u003chead\u003e\u003c/head\u003e\n  \u003cbody\u003e\n    \u003cdiv id=\"cy-container\"\u003e\n      \u003cdiv id=\"cy\" class=\"w-100 h-100\"\u003e\u003c/div\u003e\n    \u003c/div\u003e\n    \u003cscript src=\"js/cytoscape.min.js\"\u003e\u003c/script\u003e\n    \u003cscript src=\"js/layout-base.js\"\u003e\u003c/script\u003e\n    \u003cscript src=\"js/cose-base.js\"\u003e\u003c/script\u003e\n    \u003cscript src=\"js/cytoscape-fcose.js\"\u003e\u003c/script\u003e\n    \u003cscript src=\"js/cormorant.js\"\u003e\u003c/script\u003e\n    \u003cscript src=\"js/beaver.js\"\u003e\u003c/script\u003e\n    \u003cscript src=\"js/charlotte.js\"\u003e\u003c/script\u003e\n    \u003cscript src=\"js/app.js\"\u003e\u003c/script\u003e\n  \u003c/body\u003e\n\u003c/html\u003e\n```\n\nInclude in a _js/app.js_ the code to poll the hyperlocal context, retrieve any digital twins, and spin the web of devices:\n\n```javascript\nlet target = document.getElementById('cy');\n\ncharlotte.init(target, { digitalTwins: cormorant.digitalTwins });\ncharlotte.on('tap', (nodeId) =\u003e { /* Handle tap of node in graph */ });\n\ncharlotte.spin(beaver.devices, target, {});\n```\n\n\nOptions\n-------\n\n__charlotte__ supports the following options for the spin function:\n\n    {\n      filters: { minRSSI: -100 }\n    }\n\nFor instance, to spin the web of devices with signal strength (RSSI) \u003e 70 dBm, use the following options:\n\n```javascript\ncharlotte.spin(devices, target, { filters: { minRSSI: -70 } });\n```\n\n![charlotte logo](https://reelyactive.github.io/charlotte/images/charlotte-bubble.png)\n\n\nWhat's in a name?\n-----------------\n\nIn the classic children's story [Charlotte's Web](https://en.wikipedia.org/wiki/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.\n\nWhile 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!\n\nAs in the story, __charlotte.js__ can't do it all by herself.  She uses [Cytoscape.js](https://js.cytoscape.org/) to help her with the graphs themselves, while her unlikely client-side barnyard companions—[beaver](https://github.com/reelyactive/beaver), [cormorant](https://github.com/reelyactive/cormorant) and the \"radiant\" [cuttlefish](https://github.com/reelyactive/cuttlefish)—collect and prepare the source data.\n\nSpeaking of barnyard companions, __charlotte.js__ is actually our second _barn_-themed mascot after [barnowl](https://github.com/reelyactive/barnowl).  _Hay,_ isn't that \"terrific\"!\n\n\nAcknowledgements\n----------------\n\n__charlotte__ uses [Cytoscape.js](https://js.cytoscape.org/) which was created at the University of Toronto and published in Oxford Bioinformatics ([2016](https://academic.oup.com/bioinformatics/article/32/2/309/1744007), [2023](https://academic.oup.com/bioinformatics/article/39/1/btad031/6988031)), and the [cytoscape.js-fcose](https://github.com/iVis-at-Bilkent/cytoscape.js-fcose) fCoSE layout algorithm extension developed by the [iVis Lab](https://cs.bilkent.edu.tr/~ivis/) at Bilkent University.  We extend our thanks to the developers of these open source projects.\n\n\nModular Architecture\n--------------------\n\n__charlotte.js__ is easily combined with the following complementary client-side modules:\n- [beaver.js](https://github.com/reelyactive/beaver)\n- [cormorant.js](https://github.com/reelyactive/cormorant)\n- [cuttlefish.js](https://github.com/reelyactive/cuttlefish)\n\nLearn more about the [reelyActive Open Source Software packages](https://reelyactive.github.io/diy/oss-packages/), all of which are bundled together as [Pareto Anywhere](https://github.com/reelyactive/pareto-anywhere) open source IoT middleware.\n\n\nContributing\n------------\n\nDiscover [how to contribute](CONTRIBUTING.md) to this open source project which upholds a standard [code of conduct](CODE_OF_CONDUCT.md).\n\n\nSecurity\n--------\n\nConsult our [security policy](SECURITY.md) for best practices using this open source software and to report vulnerabilities.\n\n\nLicense\n-------\n\nMIT License\n\nCopyright (c) 2021-2024 [reelyActive](https://www.reelyactive.com)\n\nPermission 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:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freelyactive%2Fcharlotte","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Freelyactive%2Fcharlotte","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freelyactive%2Fcharlotte/lists"}