fizzyo / fizzyoframework-unity Goto Github PK

A Unity package for making game for project Fizzyo.

License: MIT License

C# 100.00%

fizzyoframework-unity's Introduction

Fizzyo Framework

A Unity package for Fizzyo game development . You can view more detailed documentation in the official documentation website.

This project aims to create games to help children with their breathing exercises by using games to relieve the burden of the treatment, whilst also capturing critical health data to improve clinical outcomes and future treatments.

Background on Cystic Fibrosis

Cystic Fibrosis is a chronic, life-limiting condition affecting sufferers from birth. Approximately 1 in 2500 babies are born with CF. With improved prevention and treatment life expectancy for patients has slowly increased and currently stands at an average of 41 years of age. CF physiotherapy is a series of breathing exercises undertaken as the main preventative treatment for CF. Patients are asked to do physio two or more times a day using dedicated breathing equipment to help expel mucus and fluid from their lungs. The Fizzyo device is a wireless sensor that connects to existing CF Physiotherapy equipment, turning breaths into controls for video games.

Project Fizzyo attempts to tackle some key challenges associated with chronic preventative in-home care:

How do we improve patient adherence to this form of life-long treatment when benefits are not immediate?
How do we use technology to connect the Clinician to the patient, so this traditionally analogue treatment can be monitored and made visible at point of clinical review, correlated with other health factors?
How can we study the long-term efficacy of CF Physiotherapy and its impact on patient health given no such data has ever been collected or analysed?

How the Fizzyo devices are used in CF treatment

Background information on Cystic Fibrosis

Creating a Game for Fizzyo

We've made it incredibly easy to start building your Fizzyo project and registering it with the Fizzyo cloud services.

To get started, you can follow these guides:

Register your Game with the Fizzyo cloud services - Used to integrate your game with the Fizzyo backend.
Downloading the Fizzyo Framework and integrating it with your project
Adding the Fizzyo Framework to your Scene
Building your Project for UWP

Once your Windows 10 UWP package is created, it's read for submitting to the Fizzyo project.

For additional information, the Fizzyo Framework API is also documented here.

fizzyoframework-unity's People

Contributors

Stargazers

Watchers

Forkers

andresfrj98 simondarksidej fortyix gene142

fizzyoframework-unity's Issues

Event for no exercise

update the framework to send an event to say the breathing exercise has ceased and also instrument the effect. This will then allow games to acknowledge the event and act accordingly.

Adding Capabilities into the Unity Build Process

Add-in the capabilities into the build process, to make it simpler then editing the apppackage.manifest

Add Android support

Framework should be deployable to Android devices

URI handling to the games so that we can open them from the hub

Add details of URI handling to the games so that we can open them from the hub
Games need these changes making before their final compile: https://docs.microsoft.com/en-us/windows/uwp/launch-resume/handle-uri-activation

BreathQuality always set to 4

The ExhalationCompleteEventArgs argument of the OnBreathEnded method always returns that a breath was of full quality when using BreathQuality. This was happening in one of the games already made, so I created a fresh project with a fresh scene to test this. Whether I launch through the scene itself or the calibration scene, the issue persists. It does this even with the tiniest puffs of air I blow into the device. I'm using Unity 2018.1.2f1.

Test project attached.
MyFizzyo.zip

Is Breath Full being set even for low breaths

In the example scene, the breath values report correctly, including full breaths.

However in a real project, the "Full Breath" is reported for all breaths regardless of length.

Breadth measurement

Update breath measurement within the framework based on the new firmware changes. for the over sensitive calibration code is that using the new joystick code, it might be giving joystick values from 0-255 instead of 0-1 and they will need to be re-mapped in the frameworks.

Broken links to videos in the FizzyoTreatment.md

This readme https://github.com/Fizzyo/FizzyoFramework-Unity/blob/dev/FizzyoTreatment.md
has the following broken links at the bottom:

Cystic fibrosis breathing techniques – acapella device
Cystic fibrosis breathing techniques – positive expiratory pressure (PEP) mask

FizzyoDevice.cs StreamReader(string) not compatible with UWP

A Unity build targeting UWP is not possible with the framework because of the way FizzyoDevice reads sample data files. It seems the solution is to use StorageFile.OpenReadAsync() and platform dependent compilation. I would normally submit a PR, but not sure what your plans are @gregsaul.