{"id":22326023,"url":"https://github.com/solarnetwork/eo-chart-donut","last_synced_at":"2025-10-15T22:51:39.550Z","repository":{"id":245390457,"uuid":"817977562","full_name":"SolarNetwork/eo-chart-donut","owner":"SolarNetwork","description":"A small web app to render of an instantaneous property of a datum stream from SolarNetwork as a \"donut\" style gauge chart.","archived":false,"fork":false,"pushed_at":"2025-05-27T19:00:26.000Z","size":84,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-05-27T19:45:09.499Z","etag":null,"topics":["solarnetwork","typescript","webapp"],"latest_commit_sha":null,"homepage":"https://go.solarnetwork.net/nz/eo/donut/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SolarNetwork.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-06-20T21:08:01.000Z","updated_at":"2025-05-27T19:00:30.000Z","dependencies_parsed_at":"2024-06-21T23:32:13.867Z","dependency_job_id":"e353b60c-e8cf-4c55-ac93-6dd4f02a1076","html_url":"https://github.com/SolarNetwork/eo-chart-donut","commit_stats":null,"previous_names":["solarnetwork/eo-chart-donut"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/SolarNetwork/eo-chart-donut","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SolarNetwork%2Feo-chart-donut","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SolarNetwork%2Feo-chart-donut/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SolarNetwork%2Feo-chart-donut/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SolarNetwork%2Feo-chart-donut/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SolarNetwork","download_url":"https://codeload.github.com/SolarNetwork/eo-chart-donut/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SolarNetwork%2Feo-chart-donut/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279124177,"owners_count":26108854,"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-15T02:00:07.814Z","response_time":56,"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":["solarnetwork","typescript","webapp"],"created_at":"2024-12-04T02:15:05.391Z","updated_at":"2025-10-15T22:51:39.516Z","avatar_url":"https://github.com/SolarNetwork.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Energise Ōtaki: Donut Chart\n\nThis project is a small web app to render of an instantaneous property of a datum stream from SolarNetwork as a \"donut\" style gauge chart.\n\nYou can see the chart in action here:\n\n\u003chttps://go.solarnetwork.net/nz/eo/donut/\u003e\n\n\u003cimg alt=\"Screenshot of the Energise Ōtaki Donut Chart app\" src=\"docs/eo-donut-screenshot@2x.png\" width=\"320\"\u003e\n\n# URL parameters\n\nVarious aspects of the chart can be customised via URL query parameters.\n\n\u003e :warning: Remember that the values must be URL escaped. For example a `color` parameter of\n\u003e `#FF0000` would be encoded in the URL as `color=%23FF0000`.\n\n| Parameter          | Default               | Description                                                                                                                                      |\n| :----------------- | :-------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------- |\n| `nodeId`           | 690                   | The SolarNetwork node ID of the datum stream to display.                                                                                         |\n| `sourceId`         | `EO/OC/ROOF1/SOLAR/1` | The SolarNetwork source ID of the datum stream to display.                                                                                       |\n| `propName`         | `watts`               | The datum stream property name to display.                                                                                                       |\n| `displayName`      | Power (kW)            | The property display name, shown in the tooltip when hovering over the active portion of the chart.                                              |\n| `scale`            | 1000                  | A value to divide raw property values by, to convert to the desired display scale. For example the default scale `1000` converts W values to kW. |\n| `units`            | `kW`                  | The units to display with the value.                                                                                                             |\n| `minValue`         | 0                     | The minimum overall value, expressed in display scale units.                                                                                     |\n| `maxValue`         | 24                    | The maximum overall value, expressed in display scale units.                                                                                     |\n| `barWidth`         | 50                    | The width of the donut, in pixels.                                                                                                               |\n| `width`            | 300                   | The overall width of the chart, in pixels.                                                                                                       |\n| `height`           | 300                   | The overall height of the chart, in pixels.                                                                                                      |\n| `cornerRadius`     | 0                     | If greater than `0`, a bar width ratio to round the bar endcap corners by. For example `0.5` would result in a semi-circle endcap appearance.    |\n| `color`            | `#008000`             | The bar color, as a CSS color value.                                                                                                             |\n| `backgroundColor`  | `#FFFFFF`             | The page background color, as a CSS color value.                                                                                                 |\n| `placeholderColor` | `#EDEDED`             | The bar \"placeholder\" color, that is the \"unused\" portion of the donut.                                                                          |\n| `textColor`        | `#000000`             | The text label color.                                                                                                                            |\n\n## Color values\n\nThe color parameters all accept any value CSS color, such as `#FF0000`, `rgb(255,0,0)`, and so on. For example, a query parameters value like this:\n\n```\ncolor=rgb(200%2C34%2C56)\u0026backgroundColor=%23212121\u0026placeholderColor=%23323232\u0026cornerRadius=0.1\u0026textColor=%23ededed\n```\n\nwould produce a chart like this:\n\n\u003cimg alt=\"Screenshot of the Energise Ōtaki Donut Chart app with customised colours\" src=\"docs/eo-donut-screenshot-cust@2x.png\" width=\"320\"\u003e\n\n# Building from source\n\nTo build yourself, clone or download this repository. You need to have Node 18+ installed. Then:\n\n```sh\n# initialize dependencies\nnpm ci\n\n# run development live server on http://localhost:8080\nnpm run dev\n\n# build for production\nnpm run build\n```\n\nRunning the `build` script will generate the application into the `dist/` directory.\n\n[billboard]: https://naver.github.io/billboard.js/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsolarnetwork%2Feo-chart-donut","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsolarnetwork%2Feo-chart-donut","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsolarnetwork%2Feo-chart-donut/lists"}