Differences

This shows you the differences between two versions of the page.

--- en:mobile:user_guide:vaccine [2021/04/11 03:05] – [Step 3: Sensor connection] Craig Drown
+++ en:mobile:user_guide:vaccine [2024/02/19 23:47] (current) – [Temperature Breaches] Adam Dewey
@@ Line 38: / Line 38: @@
 Approved sensors can be purchased directly from the manufacturer or reseller online.  Please contact [[coldchain@msupply.foundation]] for further information.
+==== Adding Sensors ====
+The first time you use the Vaccine module, there will be no sensors connected to your device.
+{{ :en:mobile:user_guide:pasted:20210316-035326.png?600 |}}
+Tap ''Add Sensor'' to start the three-step process to add a sensor.
+<WRAP center round important 95%>
+Please make sure that you have an approved mSupply temperature sensor.  Only approved sensors can be connected to mSupply Mobile.
+</WRAP>
+We recommend you keep the sensor close when you are adding or editing it within mSupply Mobile.  Also, allow for up to a minute for any changes to be communicated via Bluetooth.
+If you are using a brand new sensor, press the top of the sensor until it flashes to turn it on.
+== Step 1: Select the correct sensor ==
+When you tap **Add Sensor**, your device will scan and list any sensors that can be connected by Bluetooth.
+{{ :en:mobile:user_guide:pasted:20210316-035758.png?600 |}}
+If you tap the **BLINK** button, the LED light for that sensor will flash.  You can use this to make sure that you are connecting the correct sensor.
+When you are sure that you have the correct sensor, tap **Connect** for that sensor.
+== Step 2: Sensor Thresholds ==
+Firstly, some definitions:
+  * __Consecutive__ means a single event where the temperature stays over (or under) the threshold for the whole time. So if you have a threshold of 8 degrees, and a consecutive breach time of 10 minutes, then a breach that lasts for 6 minutes, then drops under the threshold for 2 minutes, then breaches again for 6 minutes is __not__ a consecutive breach, but the 2 x 6 minute breaches are added to the cumulative breach records.
+  * __Cumulative__ means adding together the total time over a certain temperature for a series of breaches.
+Now we can set the temperature breach conditions for the sensor.  There are four thresholds that you can define:
+  * Hot Consecutive
+    * A breach will be displayed when the sensor logs a temperature above this value for longer than the specified time. Using the ''+/-'' buttons, select the maximum temperature and minimum duration required to identify the breach.
+  * Cold Consecutive
+    * A breach will be displayed when the sensor logs a temperature below this value for longer than the specified time. Using the ''+/-'' buttons, select the minimum temperature and minimum duration required to identify the breach.
+  * Hot Cumulative
+    * A breach will be displayed when the sensor logs a temperature above this value for longer than the total specified time specified (total time is calculated as the sum of all breach times). Using the ''+/-'' buttons, select the maximum temperature and minimum total duration required to identify the breach.
+  * Cold Cumulative
+    * A breach will be displayed when the sensor logs a temperature below this value for longer than the total specified time specified (total time is calculated as the sum of all breach times). Using the ''+/-'' buttons, select the minimum temperature and minimum total duration required to identify the breach.
+{{ :en:mobile:user_guide:pasted:20210316-040413.png?600 |}}
+<wrap center round tip 95%>
+TIP: It is possible to **long press** the +/- buttons to change the values faster.
+</wrap>
+Tap ''Back'' if you wish to return to Step 1 and check that you have the correct sensor.
+Tap ''Next'' to move to Step 3.
+Tap ''Cancel'' if you no longer want to add the sensor.
+== Step 3: Sensor connection ==
+In this final step you need to enter:
+  ***Sensor Name**: enter a new name for the sensor. This is the name which will appear within mSupply mobile. You should choose a name to make it easy to identify the sensor.
+  ***Sensor Code**: enter a short name code for the sensor. You should choose a code that is unique for each sensor.
+<wrap center round tip 95%>
+TIP: For reporting purposes, we recommend that you do not use special characters such as “-, +, *” etc in either the Sensor Name or Sensor Code fields.
+</wrap>
+  ***Logging Interval**: using the ''+/-'' buttons, select the length of time between temperature logs.  You can set the logging interval to any length between 1 and 30 minutes. The default logging interval is 5 minutes.
+  ***Start Logging**: Use the ''+/-'' buttons to select the delay in minutes from now of the first temperature log. The sensor can be configured to start a maximum of 30 days from the current date.
+When setting the schedule for the first temperature log, allow sufficient time for the sensor to be placed in its desired location and adjust to the location’s temperature. 20 minutes should be sufficient in most situations.
+{{ :en:mobile:user_guide:pasted:20210316-040742.png?600 |}}
+Tap **Connect** to complete sensor setup and add the sensor to mSupply mobile.  This will return you to the mSupply mobile vaccine home screen and you will see the sensor has been added.
+Tap **Back** if you wish to return to Step 2 and edit the sensor thresholds (temperature breach conditions).
+Tap **Cancel** if you no longer want to add the sensor.
+{{ :en:mobile:user_guide:pasted:20210316-040934.png?600 |}}
+<WRAP center round tip 60%>
+We recommend that each device should be linked to a maximum of six sensors. Each sensor should only be linked to one device.
+</WRAP>
+==== Edit Sensor ====
+To edit sensor details, you can tap on the ‘’cog’’ icon on the mSupply Vaccine home page (above screenshot) or on the Sensor Detail screen.
+Screenshot
+All __sensor threshold__ and __sensor connection__ details are editable except for the start Logging date and time.  Simply tap on the field that you wish to end and make changes.
+{{ :en:mobile:user_guide:pasted:20210316-041102.png?600 |}}
+No changes will be made until you tap ''Save''.
+<WRAP center round info 60%>
+NOTE: Depending on your proximity to the sensor and the Bluetooth capabilities of your device, changes can take a few minutes.
+</WRAP>
+=== Pausing Sensor Downloads ===
+The edit screen also allows you to ''Pause'' temperature logging by the sensor.  When a sensor has been paused, it will appear in the title line both on the mSupply mobile vaccine home screen as well as the Sensor Detail screen.
+{{ :en:mobile:user_guide:pasted:20210316-041408.png?600 |}}
+=== Replacing a Sensor ===
+Tapping ''Replace'' will open up the scanner and allow you to choose from list of alternative sensors.  The list will only show sensors that are not currently connected to your device.
+{{ :en:mobile:user_guide:pasted:20210316-041444.png?600 |}}
+From the list, select the replacement sensor.  You can press ''Blink'' to check that you have the correct sensor (the LED light will flash for this sensor).
+=== Deleting a Sensor ===
+Tap ''Remove'' to remove any sensor no longer being used. You will receive a prompt to confirm the deletion.
+{{ :en:mobile:user_guide:pasted:20210316-041622.png?600 |}}
 ===== Using the Vaccine module =====
@@ Line 61: / Line 167: @@
   * If the breach icon (an orange triangle with an exclamation) does show for a row, this signals that the stock line has had a temperature breach. Tapping the icon will bring up a graph of the temperature breach. In the example below, the fridge seems to be broken, probably not a good idea to use this batch!
 {{ :en:mobile:user_guide:pasted:20200724-053530.png?600 |}}
 === Supplier Requisitions ===
@@ Line 131: / Line 236: @@
 </WRAP>
-=== Adding Sensors ===
+=== Temperature Breaches ===
-The first time you use the Vaccine module, there will be no sensors connected to your device.
-{{ :en:mobile:user_guide:pasted:20210316-035326.png?600 |}}
-Tap ''Add Sensor'' to start the three-step process to add a sensor.
+Temperature breaches are displayed on the graph as warning icons.
-<WRAP center round important 95%>
+As of February 2024 it is not possible to acknowledge the breaches in mSupply Mobile.
-Please make sure that you have an approved mSupply temperature sensor.  Only approved sensors can be connected to mSupply Mobile.
-</WRAP>
-We recommend you keep the sensor close when you are adding or editing it within mSupply Mobile.  Also, allow for up to a minute for any changes to be communicated via Bluetooth.
+However, note that this functionality is now available in Open mSupply: See https://docs.msupply.foundation/docs/coldchain/monitoring/#acknowledging-breaches
-If you are using a brand new sensor, press the top of the sensor until it flashes to turn it on.
-== Step 1: Select the correct sensor ==
-When you tap **Add Sensor**, your device will scan and list any sensors that can be connected by Bluetooth.
-{{ :en:mobile:user_guide:pasted:20210316-035758.png?600 |}}
-If you tap the **BLINK** button, the LED light for that sensor will flash.  You can use this to make sure that you are connecting the correct sensor.
-When you are sure that you have the correct sensor, tap **Connect** for that sensor.
-== Step 2: Sensor Thresholds ==
-Firstly, some definitions:
-  * __Consecutive__ means a single event where the temperature stays over (or under) the threshold for the whole time. So if you have a threshold of 8 degrees, and a consecutive breach time of 10 minutes, then a breach that lasts for 6 minutes, then drops under the threshold for 2 minutes, then breaches again for 6 minutes is __not__ a consecutive breach, but the 2 x 6 minute breaches are added to the cumulative breach records.
-  * __Cumulative__ means adding together the total time over a certain temperature for a series of breaches.
-Now we can set the temperature breach conditions for the sensor.  There are four thresholds that you can define:
-  * Hot Consecutive
-    * A breach will be displayed when the sensor logs a temperature above this value for longer than the specified time. Using the ''+/-'' buttons, select the maximum temperature and minimum duration required to identify the breach.
-  * Cold Consecutive
-    * A breach will be displayed when the sensor logs a temperature below this value for longer than the specified time. Using the ''+/-'' buttons, select the minimum temperature and minimum duration required to identify the breach.
-  * Hot Cumulative
-    * A breach will be displayed when the sensor logs a temperature above this value for longer than the total specified time specified (total time is calculated as the sum of all breach times). Using the ''+/-'' buttons, select the maximum temperature and minimum total duration required to identify the breach.
-  * Cold Cumulative
-    * A breach will be displayed when the sensor logs a temperature below this value for longer than the total specified time specified (total time is calculated as the sum of all breach times). Using the ''+/-'' buttons, select the minimum temperature and minimum total duration required to identify the breach.
-{{ :en:mobile:user_guide:pasted:20210316-040413.png?600 |}}
-<wrap center round tip 95%>
-TIP: It is possible to **long press** the +/- buttons to change the values faster.
-</wrap>
-Tap ''Back'' if you wish to return to Step 1 and check that you have the correct sensor.
-Tap ''Next'' to move to Step 3.
-Tap ''Cancel'' if you no longer want to add the sensor.
-== Step 3: Sensor connection ==
-In this final step you need to enter:
-  ***Sensor Name**: enter a new name for the sensor. This is the name which will appear within mSupply mobile. You should choose a name to make it easy to identify the sensor.
-  ***Sensor Code**: enter a short name code for the sensor. You should choose a code that is unique for each sensor.
-<wrap center round tip 95%>
-TIP: For reporting purposes, we recommend that you do not use special characters such as “-, +, *” etc in either the Sensor Name or Sensor Code fields.
-</wrap>
-  ***Logging Interval**: using the ''+/-'' buttons, select the length of time between temperature logs.  You can set the logging interval to any length between 1 and 30 minutes. The default logging interval is 5 minutes.
-  ***Start Logging**: Use the ''+/-'' buttons to select the delay in minutes from now of the first temperature log. The sensor can be configured to start a maximum of 30 days from the current date.
-<wrap center round tip 95%>
-TIP: When setting the schedule for the first temperature log, allow sufficient time for the sensor to be placed in its desired location and adjust to the location’s temperature.
-</wrap>
-{{ :en:mobile:user_guide:pasted:20210316-040742.png?600 |}}
-Tap **Back** if you wish to return to Step 2 and edit the sensor thresholds (temperature breach conditions).
-Tap **Connect** to complete sensor setup and add the sensor to mSupply mobile.  This will return you to the mSupply mobile vaccine home screen and you will see the sensor has been added.
-{{ :en:mobile:user_guide:pasted:20210316-040934.png?600 |}}
-Tap **Cancel** if you no longer want to add the sensor.
-<wrap center round important 95%>
-Important: We recommend that each device should be linked to a maximum of six sensors. Each sensor should only be linked to one device.
-</wrap>
-=== Edit Sensor ===
-To edit sensor details, you can tap on the ‘’cog’’ icon on the mSupply Vaccine home page (above screenshot) or on the Sensor Detail screen.
-Screenshot
-All __sensor threshold__ and __sensor connection__ details are editable except for the start Logging date and time.  Simply tap on the field that you wish to end and make changes.
-{{ :en:mobile:user_guide:pasted:20210316-041102.png?600 |}}
-No changes will be made until you tap ''Save''.
-<WRAP center round info 60%>
-NOTE: Depending on your proximity to the sensor and the Bluetooth capabilities of your device, changes can take a few minutes.
-</WRAP>
-== Pausing Sensor Downloads ==
-The edit screen also allows you to ''Pause'' temperature logging by the sensor.  When a sensor has been paused, it will appear in the title line both on the mSupply mobile vaccine home screen as well as the Sensor Detail screen.
-{{ :en:mobile:user_guide:pasted:20210316-041408.png?600 |}}
-== Replacing a Sensor ==
-Tapping ''Replace'' will open up the scanner and allow you to choose from list of alternative sensors.  The list will only show sensors that are not currently connected to your device.
-{{ :en:mobile:user_guide:pasted:20210316-041444.png?600 |}}
-From the list, select the replacement sensor.  You can press ''Blink'' to check that you have the correct sensor (the LED light will flash for this sensor).
-== Deleting a Sensor ==
-Tap ''Remove'' to remove any sensor no longer being used. You will receive a prompt to confirm the deletion.
-{{ :en:mobile:user_guide:pasted:20210316-041622.png?600 |}}
 |  //Previous:  **[[en:mobile:user_guide:cash_register|]]** | | Next:  **[[en:mobile:user_guide:mobile_settings|]]**//  |