{"id":22326019,"url":"https://github.com/solarnetwork/eo-power-overview","last_synced_at":"2025-03-26T06:11:36.214Z","repository":{"id":254202612,"uuid":"817979516","full_name":"SolarNetwork/eo-power-overview","owner":"SolarNetwork","description":"A small web app to render of an instantaneous property of a datum stream from SolarNetwork as an \"area\" style chart over time, and an accumulating property of a datum stream as a \"bar\" style chart over time.","archived":false,"fork":false,"pushed_at":"2024-08-22T00:43:09.000Z","size":158,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-01-31T07:32:04.307Z","etag":null,"topics":["solarnetwork","typescript","webapp"],"latest_commit_sha":null,"homepage":"https://go.solarnetwork.net/nz/eo/power-overview/","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:15:13.000Z","updated_at":"2024-08-22T00:43:12.000Z","dependencies_parsed_at":"2024-08-22T02:21:56.846Z","dependency_job_id":"d4f3ee8c-1a10-4be7-b3a8-f3b12348ae6d","html_url":"https://github.com/SolarNetwork/eo-power-overview","commit_stats":null,"previous_names":["solarnetwork/eo-power-overview"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SolarNetwork%2Feo-power-overview","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SolarNetwork%2Feo-power-overview/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SolarNetwork%2Feo-power-overview/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SolarNetwork%2Feo-power-overview/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SolarNetwork","download_url":"https://codeload.github.com/SolarNetwork/eo-power-overview/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245598320,"owners_count":20641884,"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","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:04.960Z","updated_at":"2025-03-26T06:11:36.197Z","avatar_url":"https://github.com/SolarNetwork.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Energise Ōtaki: Power Overview\n\nThis project is a small web app to render of an instantaneous property of a datum stream from SolarNetwork as an \"area\" style chart\nover time, and an accumulating property of the same stream as a \"bar\" style chart over time.\n\nYou can see the chart in action here:\n\n\u003chttps://go.solarnetwork.net/nz/eo/power-overview/\u003e\n\n\u003cimg alt=\"Screenshot of the Energise Ōtaki Power Overview app\" src=\"docs/eo-power-overview-screenshot@2x.png\" width=\"320\"\u003e\n\n# URL parameters\n\nVarious aspects of the charts 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 instantaneous property name to display.                                                                                         |\n| `displayName`      | Power (kW)            | The instantaneous property display name, shown in a tooltip when hovering over the active portion of the area chart.                             |\n| `accPropName`      | `wattHours`           | The datum stream accumulating property name to display.                                                                                          |\n| `accDisplayName`   | Energy (kWh)          | The accumulating property display name, shown in a tooltip when hovering over the active portion of the bar chart.                               |\n| `numHours`         | 24                    | The time period to display in the area chart, so the chart displays this many hours ending at the current hour.                                  |\n| `numMonths`        | 13                    | The time period to display in the bar chart, so the chart displays this many months ending at the current month.                                 |\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| `width`            | 300                   | The overall width of the chart, in pixels.                                                                                                       |\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 Power Overview app with customised colours\" src=\"docs/eo-power-overview-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-power-overview","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsolarnetwork%2Feo-power-overview","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsolarnetwork%2Feo-power-overview/lists"}