{"id":24440217,"url":"https://github.com/200tigersbloxed/hyperate.net","last_synced_at":"2025-10-17T03:01:23.498Z","repository":{"id":132597771,"uuid":"383280685","full_name":"200Tigersbloxed/HypeRate.NET","owner":"200Tigersbloxed","description":".NET Implementation for HypeRate.IO","archived":false,"fork":false,"pushed_at":"2021-10-27T20:44:14.000Z","size":39,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-14T01:21:15.982Z","etag":null,"topics":["csharp","hyperate","library","websockets"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/200Tigersbloxed.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2021-07-05T22:45:32.000Z","updated_at":"2024-11-05T08:43:30.000Z","dependencies_parsed_at":null,"dependency_job_id":"728a852f-767d-4787-84a3-500ef458f9fe","html_url":"https://github.com/200Tigersbloxed/HypeRate.NET","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/200Tigersbloxed/HypeRate.NET","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/200Tigersbloxed%2FHypeRate.NET","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/200Tigersbloxed%2FHypeRate.NET/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/200Tigersbloxed%2FHypeRate.NET/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/200Tigersbloxed%2FHypeRate.NET/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/200Tigersbloxed","download_url":"https://codeload.github.com/200Tigersbloxed/HypeRate.NET/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/200Tigersbloxed%2FHypeRate.NET/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279275029,"owners_count":26138539,"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-17T02:00:07.504Z","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":["csharp","hyperate","library","websockets"],"created_at":"2025-01-20T20:46:37.213Z","updated_at":"2025-10-17T03:01:23.460Z","avatar_url":"https://github.com/200Tigersbloxed.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# HypeRate.NET\r\n.NET Implementation for HypeRate.IO\r\n\r\n# Working with HypeRate.NET\r\nFor how to work with HypeRate.NET.\r\n\r\n## Getting Started\r\n\r\nFirst, go to the [Releases Page](https://github.com/200Tigersbloxed/HypeRate.NET/releases/) and download the merged dll. This dll will be your library.\r\n\r\nNow, you'll need to import this into your project. As of 7/5/2021, the project is built under .NET 4.8, but it should compatible with any .NET version, even .NET Core.\r\nOnce you have the project created, require the dll as a dependency.\r\n\r\n## Creating a new Listener\r\n\r\nNow that we have our dll imported, we need a listener, right? First, at the top of your code, make sure you're referencing HypeRate.NET.\r\n\r\n```cs\r\nusing HypeRate.NET;\r\n```\r\n\r\nNow to create a new listener, implement this at the start of your code.\r\n\r\n```cs\r\nstring sessionId = \"1234\";\r\nHeartRate hypeRate = new HeartRate(sessionId);\r\n```\r\n\r\nHere, we're creating a new HeartRate listener and passing our `sessionId` as the only parameter. \r\nDo note that if this parameter changes, you'll have to recreate the HeartRate Listener.\r\n\r\n## Subscribing to Data\r\n\r\nNow that we have our listener created, we have to Subscribe to the Data to be able to read it.\r\n\r\n```cs\r\nhypeRate.Subscribe();\r\n```\r\n\r\nThis script references our created HeartRate Listener that we created above and has it Subscribe to data. This means that we will begin listening for WebSocket traffic from HypeRate's socket.\r\n\r\n## Reading Data\r\n\r\nSince HypeRate only gets your HeartRate, let's get the HeartRate. Note that for this to work, you must be Subscribed to data!\r\n\r\n```cs\r\nexampleInt = hypeRate.HR;\r\n```\r\n\r\nHere, `exampleInt` is an example variable that is an `int` and `hypeRate.HR` is the last recorded HeartRate. This can be cast to a string as well if you want to:\r\n\r\n```\r\nexampleInt = hypeRate.HR;\r\nstring heartRateText = exampleInt.ToString();\r\n```\r\n\r\n## Unsubscribing from Data\r\n\r\nOnce you're done reading Data, be sure to Unsubscribe from it.\r\n\r\n```cs\r\nhypeRate.Unsubscribe();\r\n```\r\n\r\nThis should be called whenever you aren't actively reading HeartRate data or you won't be for a while. It wouldn't hurt to leave it on, but if you want to save resources, it is recommended.\r\n\r\n## Unity Notes\r\n\r\nSince HypeRate.NET uses `System.Timers` to function, it is **NOT** recommended to test HypeRate.NET in the Editor. If you do decide to use HypeRate.NET in the Unity Editor for testing, please be sure to unsubscribe from data, otherwise, it'll keep looping.\r\n\r\n# Building HypeRate.NET from source\r\nFor developers who want to make changes\r\n\r\n## Dependencies\r\n\r\nHypeRate.NET requires the following NuGet Dependencies:\r\n\r\n+ [Newtonsot.Json](https://www.nuget.org/packages/Newtonsoft.Json/)\r\n\r\nHypeRate.NET requires the following external Dependencies:\r\n\r\n+ [websocket-sharp](https://github.com/sta/websocket-sharp)\r\n\r\nHypeRate.NET requires the following internal Dependencies:\r\n\r\n+ System\r\n+ System.Timers\r\n\r\n## Building\r\n\r\nDownload the latest source code, of course, and open the .vs file in a preferred IDE. (I used VS2019)\r\n\r\nImport the Dependencies, as seen above.\r\n\r\nBuild HypeRate.NET first, then HypeRate.NET.Test.\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F200tigersbloxed%2Fhyperate.net","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F200tigersbloxed%2Fhyperate.net","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F200tigersbloxed%2Fhyperate.net/lists"}