Skip to content

Commit

Permalink
docs2
Browse files Browse the repository at this point in the history
  • Loading branch information
cyferorg committed Aug 3, 2023
1 parent f382f67 commit b92ed63
Show file tree
Hide file tree
Showing 29 changed files with 3,398 additions and 0 deletions.
Binary file added cyferhealth/docs2/alerts/appicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
131 changes: 131 additions & 0 deletions cyferhealth/docs2/alerts/settings.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
<!DOCTYPE html>
<html lang="en">
<meta charset="utf-8">
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.11.2/css/all.css">
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.11.2/css/v4-shims.css">
<link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons">
<title>Cyfer Health Remote Settings page</title>
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="icon" type="image/png" href="./appicon.png">
<!--[if lte IE 8]><link rel="stylesheet" href="../responsive-nav.css"><![endif]-->
<!--[if gt IE 8]><!--><link rel="stylesheet" href="../styles.css"><!--<![endif]-->


<style>
#settingstable tr:nth-child(even) {
background-color: #dddddd;
}
#settingstable table, #settingstable th, #settingstable td {
border: 1px solid black;
}
</style>
<body>
<script src="../nav.js"></script>
<h1>Cyfer Health Alerts</h1>
<h3>Cyfer Health's Document Terminology</h3>
<p><i>Patient</i> is the person being looked after. Unless you are a professional carer you probably don't think of this person as a 'patient' but instead they are a relative or a friend to whom you are responsible for their welfare.</p>
<p><i>Carer</i> is the person looking after the <i>patient</i>. This documentation assumes that the reader is the <i>Carer</i> so when 'you' is used, it is referring to the role of the <i>Carer</i>.</p>
<p>There will often be more than one <i>Carer</i>, e.g. siblings looking after a parent; and within a health care organisation there is likely to be a large number of <i>Carers</i>. Likewise, within such a care organisation, there are likely to be a large number of <i>Patients</i>.</p>
<h2>Message screen</h2>
<p>This is the only screen the patient will see and the only one they will interact with. It is optional, but the Cyfer Health Alerts app is usually the only app installed and visible on the device. Hence, the Message screen will be always visible to the patient apart from any device screen-off settings.</p>
<p>The screen displays messages sent by carers. Each received message is scaled to take up the entire display apart from a small margin at the bottom of the screen showing there is more than one message available. When a message arrives, the screen turns-on (if off) and flashes, and, optionally, an alarm is sounded. (The message will also be displayed on the patient's Cyfer Health Client app.) Tapping the message on the Alert app or Client app stops the flashing and turns-off the alarm. If the Carer who sent the message has requested a response, the patient will be prompted to tap one of the response buttons. Even when the Carer has not requested a response, an email will still be sent to them let them know that the Patient has tapped the message. Once the Patient has read the message, they can either delete it by tapping the bin icon or just leave it. In case of the latter, any new messages will be made visible and old messages scrolled off the screen.</p>
<div id="settingstable">
<h2>Settings</h2>
<p>In order to remove clutter, and potential confusion, from the main screen, there isn't a button to access the Settings page from this screen. Instead, to access the Settings page, the app's notification should be dragged down and the Settings button (which will now be visible) tapped.</p>
<p>There are three command buttons at the top of the Settings page:</p>
<table style="width:100%">
<tr>
<td>Check box</td>
<td>Tap to check the email address and password. If the settings work, the icon will go green.</td>
</tr>
<tr>
<td>Padlock</td>
<td>Tap to set or remove PIN access to the Settings page. Enter a value of 0000 to remove the requirement to enter a PIN.</td>
</tr>
<tr>
<td>Power off</td>
<td>Tap to shutdown the Cyfer Health Alerts app.</td>
</tr>
</table>
<p>The settings on the Settings page:</p>
<table style="width:100%">
<tr>
<td>Device name</td>
<td>This is a name that can be used to identify the <i>device</i>. A good naming approach is to name the device after its location, e.g. bedroom or living room. It should be quite short. (Less than 12 characters).</td>
</tr>
<tr>
<td>Patient's Cyfer Health Email Address</td>
<td>Enter the patient's Cyfer Health Client email address. This is the Google email address you will have created when setting-up their Cyfer Health Client app.</td>
</tr>
<tr>
<td>Patient's Email Password</td>
<td>Enter the patient's Cyfer Health Client email app password. This is the same password you will have created when setting-up their Cyfer Health Client app.</td>
</tr>
<tr>
<td>Debug email</td>
<td>Ignore this one.</td>
</tr>
<tr>
<td>Always display on top</td>
<td>Switching this on ensures that the Cyfer Health Alert app is always visible. If the app is running on a dedicated device then it would be best to enable this setting. If the app is on a device that is used for other things e.g. reading email, then the setting should be switched off.</td>
</tr>
<tr>
<td>Set max alarm volume</td>
<td>Switch on if you want the volume of the alarm (played when the Cyfer Health Client receives a message) to be set to maximum. This can be useful if the patient has accidentally lowered or muted their device's volume settings.</td>
</tr>
<tr>
<td>Reset volume</td>
<td>If <i>Set max alarm volume</i> is enabled, enabling <i>Reset volume</i> will restore the device's alarm volume setting to its value before the alarm was sounded.</td>
</tr>
<tr>
<td>Always keep lock on</td>
<td>This should only be enabled if the device Cyfer Health Alerts is running on loses network connection. This only seems to occur on a small number of older devices. To test if it is required, leave the device over night and then send a message. If the device detects the message, it is unlikely that the setting is required.</td>
</tr>
<tr>
<td>Ignore lock during night</td>
<td>This setting is only relevant if <i>Always keep lock on</i> is enabled. If <i>Always keep lock on</i> is enabled, you will probably find that the device's screen is turned on every few hours before turning off again. This can be distracting if the device is near the patient's bed and the environment is dark. In such a situation, turn on <i>Ignore lock during night</i>. When on, the device's screen will no longer light-up over-night. However, the device might not receive messages during the night. As mitigation for this issue, it is unlikely that messages would need to be sent to the patient while they are, or should be, sleeping.</td>
</tr>
<tr>
<td>Turn off Do Not Disturb</td>
<td>(This setting might not be available) Allows Cyfer Health Alerts to turn off Android's Do Not Disturb (DND) function. DND may have been accidentally switched on by the Patient or may be turned on a timer in order, for example, not to disturb the patient overnight with unimportant notification sounds.</td>
</tr>
<tr>
<td>Only trusted email addresses</td>
<td>If on, only process emails (such as messages) from email addresses that you trust. These are the email addresses specified in the above 'Emergency Email Address(es)' entry and, if you are not using Stand-alone mode, the Cyfer Health Server's email address. This reduces signifcantly the risk of the patient's devices being spammed with unwanted email. However, even without switching this on, spamming is unlikley since the Cyfer Health emails have a dedicated format and the patient's Cyfer email address is never published so shouldn't be picked up by spammers.</td>
</tr>
<tr>
<td>Trusted email addresses</td>
<td>Enter the email addresses you wish to allow to send messages and commands to the patient. Separate each email by a comma, e.g. [email protected], [email protected], [email protected]</td>
</tr>
<tr>
<td>Select alarm</td>
<td>Choose the sound that should be played when a message is received. The sound should be one that is looped continuously rather than one that ends after a couple of seconds. If you want to set a particular volume for the alarm, start playing the alarm sound, then using the device's volume controls change the volume to the required colume, and then tap the <i>Set volume</i> button.</td>
</tr>
<tr>
<td>Display orientation</td>
<td>Once the Cyfer Health Alerts app has started the device's screen orientation won't change, i.e. between landscape and portrait orientations. This is so that the patient is not confused or irritated by the screen's layout changing as they handle the device. The required orientation can have one of the following values: Automatic, Landscape, Portrait.</td>
</tr>
<tr>
<td>Use Emergency button</td>
<td>Switch on in order to use a Bluetooth emergency button. Then, once the button is active, i.e. prss the button, tap the Scan button and select the device in the drop-down list underneath the Scan button.</td>
</tr>
<tr>
<td>Emergency email addresses</td>
<td>A comma separated list of email addresses to which an email should be sent when the Patient presses their emergency button. Note that if you are using Cyfer Health Monitor, one of the addresses should be that of the Monitor.</td>
</tr>
<tr>
<td>Delete all messages</td>
<td>Delete all the received messages. If there are several messages, this message is much faster than deleting the individual messages.</td>
</tr>
</table>
</div>

<pre>

</pre>

<script>
var navigation = responsiveNav("#nav", {customToggle: ".nav-toggle"});
</script>
</body>
</html>
Binary file added cyferhealth/docs2/client/appicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
158 changes: 158 additions & 0 deletions cyferhealth/docs2/client/settings.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,158 @@
<!DOCTYPE html>
<html lang="en">
<meta charset="utf-8" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
<link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons">
<title>Cyfer Health Client Settings page</title>
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="icon" type="image/png" href="./appicon.png"/>
<!--[if lte IE 8]><link rel="stylesheet" href="../responsive-nav.css"><![endif]-->
<!--[if gt IE 8]><!--><link rel="stylesheet" href="../styles.css"><!--<![endif]-->
<script src="../responsive-nav.js"></script>

<style>
#settingstable tr:nth-child(even) {
background-color: #dddddd;
}
#settingstable table, #settingstable th, #settingstable td {
border: 1px solid black;
}
</style>
<body>
<script src="../nav.js"></script>
<h1>Cyfer Health Client</h1>
<h3>Cyfer Health's Document Terminology</h3>
<p><i>Patient</i> is the person being looked after. Unless you are a professional carer you probably don't think of this person as a 'patient' but instead they are a relative or a friend to whom you feel responsible, in some way, for their welfare.</p>
<p><i>Carer</i> is the person looking after the <i>patient</i>. This documentation assumes that the reader is the <i>Carer</i> so when 'you' is used, it is referring to the role of the <i>Carer</i>.</p>
<p>There will often be more than one <i>Carer</i>, e.g. siblings looking after a parent; and within a health care organisation there is likely to be a large number of <i>Carers</i>. Likewise, within such a care organisation, there are likely to be a large number of <i>Patients</i>.</p>
<div id="settingstable">
<h2>Settings</h2>

<h3>Commands available at the top of the Settings page</h3>
<table style="width:100%">
<tr>
<td style="text-align:center;"><i class="fa fa-check-square-o"></i>
</td>
<td>Tap to test the email settings that have been entered on this page.</td>
</tr>
<tr>
<td style="text-align:center;"><i class="fa fa-lock"></i>&nbsp;&nbsp;<i class="fa fa-unlock"></i></td>
<td>Tap to set the PIN that controls access to this page.</td>
</tr>
<tr>
<td style="text-align:center;"><i style="color:red;text-align:center;" class="fa fa-power-off"></i></td>
<td>Tap to stop Cyfer Health Client running.</td>
</tr>
</table>

<h3>The settings and commands available on the Settings page.</h3>

<table style="width:100%">
<tr>
<td>Stand-alone mode</td>
<td>Turn off if you are an organisation looking after several patients. Turn on if you are an individual looking after one or just a few patients.</td>
</tr>
<tr>
<td>Patient's name</td>
<td>This is the name you wish to use to identify the patient. It should be quite short. (Less than 10 characters).</td>
</tr>
<tr>
<td>Patient's Cyfer Health Email Address</td>
<td>Each patient must be given a unique GMail email address. (This should not be their personal or any other existing email address.) You should create a new Google account for the patient and then use the email address associated with that new account here.</td>
</tr>
<td>Patient's Email Password</td>
<td>The app password associated with the patient's Cyfer Health email address. This is not the Google account password! The app password is generated from within the Security settings page of the patient's Google account. See here for more info XXXXXXXXXXX</td>
</tr>
<td>Centre's Email Address</td>
<td>(Only relevant if Stand-alone mode is off.) The email address of your organisation's Cyfer Health Server.</td>
</tr>
<tr>
<td>Emergency Email Address(es)</td>
<td>The email addresses of any carers that should receive alert emails that are generated by Cyfer Health Client, such as unusually low or high heart readings.</td>
</tr>
<tr>
<td>Send summary email at</td>
<td>A daily summary email can be generated and sent to the Emergency Email Addresses. If that is required, enter the time at which the email should be generated and sent. Setting the time at 8am, for example, will produce an email that summarises the events between 8am the previous day and 8am on the current day.</td>
</tr>
<tr>
<td>How often, in days, to email all readings</td>
<td>An email with all heart rate readings (which may be of a higher frequency than that sent to the Centre) can be sent to the Emergency Email Addresses. The attached file of readings can be analysed in an application such as Excel. If this is required, enter the number of consecutive days to capture before sending an email.</td>
</tr>
<tr>
<td>Low heart alert</td>
<td>The heart rate, e.g. 35 beats per minute, below which an email alert should be generated.</td>
</tr>
<tr>
<td>High heart alert</td>
<td>The heart rate, e.g. 150 beats per minute, above which an email alert should be generated.</td>
</tr>
<tr>
<td>Sound alarm</td>
<td>Switch on if you require an alarm to sound on the Cyfer Health Client device if either a low or high heart alert is detected. (You are unlikely to want to switch this on. It is mainly of interest if you are using the app to monitor your own heart.)</td>
</tr>
<tr>
<td>Set max alarm volume</td>
<td>Switch on if you want the volume of the alarm (played when the Cyfer Health Client receives a message) to be set to maximum. This can be useful if the patient has accidentally lowered or muted their device's volume settings.</td>
</tr>
<tr>
<td>Reset volume</td>
<td>After setting maximum volume (if the above setting is enabled), return the volume to its previous value.</td>
</tr>
<tr>
<td>Turn off Do Not Disturb</td>
<td>As for 'Set max alarm volume', it can be useful to switch this option on to address the case where the patient has accidentally turned on Android's Do Not Disturb function.</td>
</tr>
<tr>
<td>Start Watchdog</td>
<td>Start the optional Cyfer Watchdog app and ensure that the Watchdog continues to run. The Watchdog app ensures that the Cyfer Client Health app is operational. (It is a reciprocal relationship: Watchdog ensures Cyfer Health Client stays operational and Cyfer Health Client ensures Watchdog stays operational.)</td>
</tr>
<tr>
<td>Only trusted email addresses</td>
<td>If on, only process emails (such as messages) from email addresses that you trust. These are the email addresses specified in the above 'Emergency Email Address(es)' entry and, if you are not using Stand-alone mode, the Cyfer Health Server's email address. This reduces significantly the risk of the patient's devices being spammed with unwanted email. However, even without switching this on, spamming is unlikley since the Cyfer Health emails have a dedicated format and the patient's Cyfer email address is never published so shouldn't be picked up by spammers.</td>
</tr>
<tr>
<td>Show name</td>
<td>Show the patient's name on the main (graph) page.</td>
</tr>
<tr>
<td>Show steps</td>
<td>Show the number of steps the patient has taken today, if available.</td>
</tr>
<tr>
<td>(Advanced) Debug email</td>
<td>Do not use this setting. It is only for the app's developer.</td>
</tr>
<tr>
<td>(Advanced) Start third-party app</td>
<td>(Only works if using the non-lite version of Watchdog.)</td>
</tr>
<tr>
<td>Patient's band</td>
<td>Initiate scanning for the patient's Bluetooth health band. Then select (by tapping) the list entry that corresponds to the patient's health band. (The text of the currently selected band will be bold.) If you select the wrong entry, try again.</td>
</tr>
<tr>
<td>Use emergency button</td>
<td>Turn on if the patient has a Bluetooth emergency button that can operate with Cyfer Health Client. Once configured, pressing the emergency button will send an email to the emergency address(es) and sound an alarm within the Cyfer Health Monitor app.</td>
</tr>
<tr>
<td>Emergency button</td>
<td>As for specifying the patient's health band, select the list entry that corresponds to the patient's emergency button.</td>
</tr>

</table>
<h2>Emergency Button</h2>
<p>Most simple Bluetooth 'button' devices can be used as an Emergency Button. A typical such device is a remote shutter release button that can be bought for a few pounds. One device can be used simultaneously with a Cyfer Health Client app and any number of Cyfer Health Alert apps. (Provided the button is running in unpaired mode - see below.) Placing devices running Cyfer Health Alert around the patient's home ensures that, even if the patient is not close to their phone running Cyfer Health Client, the emergency button is always detectable.</p>
<p>The button device can operate in two different modes. A mode where it is paired with the patient's device (this is typically how Bluetooth devices such as headphones are connected to mobile phones); and a mode where it is unpaired. The advantage of being paired is that the button will be more response (it can be pressed as many times as desired), whereas if it is unpaired, it can only be pressed once every 10 minutes. The problem with the paired mode, is that some buttons may not be detectable by the Cyfer Health Client app. In these cases, obviously, the unpaired mode should be used. In practice, it is very unlikely that an emergency button would need to be pressed more frequently than once every few hours.</p>
<p>To configure a button in paired mode, first pair the button with the patient's device (typically via Android's Bluetooth settings screen) and then select the button from the drop-down list within Cyfer Health Client apps's Settings page. You can then test it by pressing the button. If a test message is not displayed, consider using unpaired mode.</p>
<p>To configure a button in unpaired mode, don't pair the button with the patient's device and if you have already paired it, use Android's Bluetooth settings to unpair it. Once it is definitely unpaired, select the button from the drop-down list within Cyfer Health Client apps's Settings page. The button is likely to have an indicator (often a blue LED) that flashes when the button is active. Once this indicator is no longer lit, you can test the button by pressing it. The indicator will start flashing again and Cyfer Health Client app should show a confirmation message. You will need to wait at least 10 minutes before the button will allow another emergency alert to be generated.</p>
</div>

<pre>

</pre>

<script>
var navigation = responsiveNav("#nav", {customToggle: ".nav-toggle"});
</script>
</body>
</html>
Loading

0 comments on commit b92ed63

Please sign in to comment.