Bluetooth: Difference between revisions

From ARIS
Jump to navigation Jump to search
Pau (talk | contribs)
Alberto (talk | contribs)
Marked this version for translation
 
(24 intermediate revisions by 4 users not shown)
Line 1: Line 1:
[[Category:ARIS:Bluetooth]]
[[Category:Bluetooth]]
<languages/>
<translate>
<!--T:1-->
The Bluetooth feature allows a bidirectional information exchange between the [[ARIS:main|ARIS]] and the [http://dl-prod.essi.upc.edu/IMAGINGwiki/index.php/MobileApp:Main Mobile App]. When enabled, the users will be able to establish a wireless connection with ARIS within the Mobile App, and perform two basic operations from the device.
# Extract from ARIS a list of test identifiers (i.e., a worklist) from those [[Configuration#Analytical_tests|Analytical tests]] which are in ''Processing'' state and marked as ''Automatic''.
# Transfer back to ARIS the images taken from each one of those tests, captured with the Mobile app through the microscope.


The Bluetooth feature allows a bidirectional information exchange between the [[ARIS:main|ARIS]] system and the [[MobileApp:Main|Mobile App]]. When enabled, the users will be able to establish a wireless connection with ARIS within the Mobile App, and perform two basic operations from the device.
<!--T:2-->
# Extract from ARIS a list of test identifiers (i.e., a worklist) from those [[ARIS:Configuration#Analytical_tests|Analytical tests]] which are in ''Processing'' state and marked as ''Automatic''.
__TOC__
# Transfer back to ARIS the images taken from each one of those tests, captured with the Mobile app through the microscope.


==Relevant system paremeters== <!--T:3-->


__TOC__
===''bluetooth_enabler''=== <!--T:15-->


==Relevant system paremeters==
<!--T:16-->
===''bluetooth_enabler''===
[[File:DownloadingNN.PNG|right|600px|thumb|Window while downloading AI model]]
By default, the Bluetooth functionality is disabled for everybody.  
By default, the Bluetooth functionality is disabled for everybody.  
To allow the usage of this feature, a logged ''System Administrator'' must set the 'bluetooth_enabler' parameter to 'Enabled' from the [[ARIS:System_administration#Parameters|Parameters]] configuration page.  
To allow the usage of this feature, a logged ''System Administrator'' must set the 'bluetooth_enabler' parameter to 'Enabled' from the [[System_administration#Parameters|Parameters]] configuration page.
After this, a Bluetooth icon will be visible to all ''Laboratory Technicians'' in the [[ARIS:User Guide#Navigation bar|Navigation bar]] section, allowing them to enable and disable the Bluetooth connections of the ARIS system by clicking the mentioned icon.
Immediately, the download process of the Artificial Intelligence model for automatic image analysis will start, in case that the required file was not previously downloaded.
After this, in case of success (note that internet connection is required in order to perform the download), a Bluetooth icon will be visible to all ''Laboratory Technicians'' in the [[User Guide#Navigation bar|Navigation bar]] section, allowing them to enable and disable the Bluetooth connections of the ARIS system by clicking the mentioned icon.
 
<!--T:4-->
In the same way, the Bluetooth functionality can be disabled anytime by a logged ''System Administrator'' from the same [[System_administration#Parameters|Parameters]] configuration page by setting the 'bluetooth_enabler' parameter to 'Disabled'. This change will hide back the Bluetooth icon, preventing ''Laboratory Technitians'' from enabling or disabling Bluetooth connections.
 
===''max_image_volume''=== <!--T:5-->


In the same way, the Bluetooth functionality can be disabled anytime by a logged ''System Administrator'' from the same [[ARIS:System_administration#Parameters|Parameters]] configuration page by setting the 'bluetooth_enabler' parameter to 'Disabled'. This change will hidden back the Bluetooth icon, preventing ''Laboratory Technitians'' from enabling or disabling Bluetooth connections.
<!--T:17-->
===''max_image_volume''===
The 'max_image_volume' parameter from the [[System_administration#Parameters|Parameters]] configuration page refers to the maximum number of megabytes used to store images from the automatically analyzed tests in the whole system. Once the limit is reached, the oldest images in the folder are deleted until the image volume is below the indicated value.
The 'max_image_volume' parameter from the [[ARIS:System_administration#Parameters|Parameters]] configuration page refers to the maximum number of megabytes used to store images from the automatically analyzed tests in the whole system. Once the limit is reached, the oldest images in the folder are deleted until the image volume is below the indicated value.


==Usage==
==Usage== <!--T:6-->
When the Bluetooth functionality is enabled from system [[ARIS:System_administration#Parameters|Parameters]], one of three different icons can be seen in the [[ARIS:User Guide#Navigation bar|Navigation bar]].  
When the Bluetooth functionality is enabled from system [[System_administration#Parameters|Parameters]], one of three different icons can be seen in the [[User Guide#Navigation bar|Navigation bar]].  


===Bluetooth OFF===
===Bluetooth OFF=== <!--T:7-->
 
<!--T:18-->
[[File:Bluetooth_off.PNG|left|50px]]
[[File:Bluetooth_off.PNG|left|50px]]
A grey Bluetooth OFF icon indicates that, currently, ARIS is not being visible to other devices, such as those running the [[MobileApp:Main|Mobile App]], preventing them from establishing Bluetooth connections with the system.  
A grey Bluetooth OFF icon indicates that, currently, ARIS is not being visible to other devices, such as those running the [http://dl-prod.essi.upc.edu/IMAGINGwiki/index.php/MobileApp:Main Mobile App], preventing them from establishing Bluetooth connections with the system.  
If clicked, the Bluetooth OFF icon turns into an orange [[ARIS:Bluetooth#Bluetooth_ON|Bluetooth ON]] icon.
If clicked, the Bluetooth OFF icon turns into an orange [[Bluetooth#Bluetooth_ON|Bluetooth ON]] icon.


===Bluetooth ON===
===Bluetooth ON=== <!--T:8-->
 
<!--T:19-->
[[File:Bluetooth_on.PNG|left|50px]]
[[File:Bluetooth_on.PNG|left|50px]]
An orange Bluetooth ON icon indicates that ARIS is visible to other devices, and therefore a [[MobileApp:Main|Mobile App]] can establish a Bluetooth connection with the system whenever needed.  
An orange Bluetooth ON icon indicates that ARIS is visible to other devices, and therefore a [http://dl-prod.essi.upc.edu/IMAGINGwiki/index.php/MobileApp:Main Mobile App] can establish a Bluetooth connection with the system whenever needed.  
If clicked, the Bluetooth ON icon turns into a grey [[ARIS:Bluetooth#Bluetooth_OFF|Bluetooth OFF]] icon.
If clicked, the Bluetooth ON icon turns into a grey [[Bluetooth#Bluetooth_OFF|Bluetooth OFF]] icon.


===Loading===
===Loading=== <!--T:9-->
 
<!--T:20-->
[[File:Bluetooth_loading.PNG|left|50px]]
[[File:Bluetooth_loading.PNG|left|50px]]
When image transmission using the Bluetooth feature is taking place between the [[MobileApp:Main|Mobile App]] and ARIS, the [[ARIS:Bluetooth#Bluetooth_ON|Bluetooth ON]] icon turns automatically into an animated orange circle. This icon is not clickable and keeps visible while the mentioned procedure is not over. Moreover, a dropdown next to it appears showing, for all tests being transmited, the download progress or the number of images being analyzed, depending on the stage of the process each test is at.
When image transmission using the Bluetooth feature is taking place between the [http://dl-prod.essi.upc.edu/IMAGINGwiki/index.php/MobileApp:Main Mobile App] and ARIS, the [[Bluetooth#Bluetooth_ON|Bluetooth ON]] icon turns automatically into an animated orange circle. This icon is not clickable and keeps visible while the mentioned procedure is not over. Moreover, a dropdown next to it appears showing, for all tests being transmited, the download progress or the number of images being analyzed, depending on the stage of the process each test is at.
Once the image transmission finalizes, this icon turns automatically into the previous [[ARIS:Bluetooth#Bluetooth_ON|Bluetooth ON]] icon and the dropdown disappears.
Once the image transmission finalizes, this icon turns automatically into the previous [[Bluetooth#Bluetooth_ON|Bluetooth ON]] icon and the dropdown disappears.
[[File:Receiving.png|centre|200px]]


==States==
==States== <!--T:10-->
<!--div style="float:right; margin: 0px 0px 0px 0px"-->
 
<!--T:21-->
<div style="float:right; margin: 0px 0px 0px 0px">
<graphviz border='frame' format='svg' caption='ARIS Bluetooth states'>
<graphviz border='frame' format='svg' caption='ARIS Bluetooth states'>
digraph StatesDiagram {
digraph StatesDiagram {
Line 59: Line 79:
     ExecutingModel -> ReceivingImages; //  [constraint=false];
     ExecutingModel -> ReceivingImages; //  [constraint=false];
     Waiting -> End [label="Disable Bluetooth"]; // [constraint=false];
     Waiting -> End [label="Disable Bluetooth"]; // [constraint=false];
     //{ rank=same; Begin Registered Processing WithResults Validated}
     //{ rank=same; Begin Registered Processing WithResults Validated}
     //{ rank=same; Cancelled End}
     //{ rank=same; Cancelled End}
}
}
</graphviz>
</graphviz>
<!--/div-->
</div>
In any given time, the Bluetooth system can be in four different states if [[ARIS:Bluetooth#Bluetooth_ON|Bluetooth is ON]].
In any given time, the Bluetooth system can be in four different states if [[Bluetooth#Bluetooth_ON|Bluetooth is ON]].
===Waiting===
 
ARIS is visible to other devices and ready to response to requests made from the [[MobileApp:Main|Mobile App]]. In this point can receive the order to send the current worklist to the Mobile, to receive images from the Mobile or, otherwise, disable any Bluetooth connection by turning the [[ARIS:Bluetooth#Bluetooth_OFF|Bluetooth OFF]] in the [[ARIS:User Guide#Navigation bar|Navigation bar]].
===Waiting=== <!--T:11-->
===Transfering Worklist===
 
ARIS is sending to the [[MobileApp:Main|Mobile App]] that has made the request the list of test identifiers from those [[ARIS:Configuration#Analytical_tests|Analytical tests]] which are in ''Processing'' state and marked as ''Automatic'', known as worklist. Once the transfer is done, ARIS goes back to [[ARIS:Bluetooth#Waiting|Waiting]] state.
<!--T:22-->
===Receiving Images===
ARIS is visible to other devices and ready to respond to requests made from the [http://dl-prod.essi.upc.edu/IMAGINGwiki/index.php/MobileApp:Main Mobile App]. At this point, it can receive the order to send the current worklist to the Mobile, to receive images from the Mobile or, otherwise, disable any Bluetooth connection by turning the [[Bluetooth#Bluetooth_OFF|Bluetooth OFF]] in the [[User Guide#Navigation bar|Navigation bar]].
ARIS is receiving the images taken from one or more of those previously sent tests, captured with the [[MobileApp:Main|Mobile App]] through the microscope. Every test in the set of images can have as many images as needed. Once the last image of a test is received, the model is executed in parallel for all of the images from that test. Meanwhile, ARIS can keep receiving images of other tests, or go back to [[ARIS:Bluetooth#Waiting|Waiting]] state if no more images are being transfered.
 
===Executing Model===
===Transfering Worklist=== <!--T:12-->
ARIS is running the AI Model for all of the previously received images of an [[ARIS:Configuration#Analytical_tests|Analytical test]], in order to automatically analyze them and obtain a diagnosis.
 
<!--T:23-->
ARIS is sending to the [http://dl-prod.essi.upc.edu/IMAGINGwiki/index.php/MobileApp:Main Mobile App] that has made the request the list of test identifiers from those [[Configuration#Analytical_tests|Analytical tests]] which are in ''Processing'' state and marked as ''Automatic'', known as worklist. Once the transfer is done, ARIS goes back to [[Bluetooth#Waiting|Waiting]] state.
 
===Receiving Images=== <!--T:13-->
 
<!--T:24-->
ARIS is receiving the images taken from one or more of those previously sent tests, captured with the [http://dl-prod.essi.upc.edu/IMAGINGwiki/index.php/MobileApp:Main Mobile App] through the microscope. Every test in the set of images can have as many images as needed. Once the last image of a test is received, the model is executed in parallel for all of the images from that test. Meanwhile, ARIS can keep receiving images of other tests, or go back to [[Bluetooth#Waiting|Waiting]] state if no more images are being transferred.
 
===Executing Model=== <!--T:14-->
 
<!--T:25-->
ARIS is running the AI Model for all of the previously received images of an [[Configuration#Analytical_tests|Analytical test]], in order to automatically analyze them and obtain a diagnosis.
</translate>

Latest revision as of 15:46, 2 February 2024

The Bluetooth feature allows a bidirectional information exchange between the ARIS and the Mobile App. When enabled, the users will be able to establish a wireless connection with ARIS within the Mobile App, and perform two basic operations from the device.

  1. Extract from ARIS a list of test identifiers (i.e., a worklist) from those Analytical tests which are in Processing state and marked as Automatic.
  2. Transfer back to ARIS the images taken from each one of those tests, captured with the Mobile app through the microscope.

Relevant system paremeters[edit]

bluetooth_enabler[edit]

Window while downloading AI model

By default, the Bluetooth functionality is disabled for everybody. To allow the usage of this feature, a logged System Administrator must set the 'bluetooth_enabler' parameter to 'Enabled' from the Parameters configuration page. Immediately, the download process of the Artificial Intelligence model for automatic image analysis will start, in case that the required file was not previously downloaded. After this, in case of success (note that internet connection is required in order to perform the download), a Bluetooth icon will be visible to all Laboratory Technicians in the Navigation bar section, allowing them to enable and disable the Bluetooth connections of the ARIS system by clicking the mentioned icon.

In the same way, the Bluetooth functionality can be disabled anytime by a logged System Administrator from the same Parameters configuration page by setting the 'bluetooth_enabler' parameter to 'Disabled'. This change will hide back the Bluetooth icon, preventing Laboratory Technitians from enabling or disabling Bluetooth connections.

max_image_volume[edit]

The 'max_image_volume' parameter from the Parameters configuration page refers to the maximum number of megabytes used to store images from the automatically analyzed tests in the whole system. Once the limit is reached, the oldest images in the folder are deleted until the image volume is below the indicated value.

Usage[edit]

When the Bluetooth functionality is enabled from system Parameters, one of three different icons can be seen in the Navigation bar.

Bluetooth OFF[edit]

A grey Bluetooth OFF icon indicates that, currently, ARIS is not being visible to other devices, such as those running the Mobile App, preventing them from establishing Bluetooth connections with the system. If clicked, the Bluetooth OFF icon turns into an orange Bluetooth ON icon.

Bluetooth ON[edit]

An orange Bluetooth ON icon indicates that ARIS is visible to other devices, and therefore a Mobile App can establish a Bluetooth connection with the system whenever needed. If clicked, the Bluetooth ON icon turns into a grey Bluetooth OFF icon.

Loading[edit]

When image transmission using the Bluetooth feature is taking place between the Mobile App and ARIS, the Bluetooth ON icon turns automatically into an animated orange circle. This icon is not clickable and keeps visible while the mentioned procedure is not over. Moreover, a dropdown next to it appears showing, for all tests being transmited, the download progress or the number of images being analyzed, depending on the stage of the process each test is at. Once the image transmission finalizes, this icon turns automatically into the previous Bluetooth ON icon and the dropdown disappears.

States[edit]

In any given time, the Bluetooth system can be in four different states if Bluetooth is ON.

Waiting[edit]

ARIS is visible to other devices and ready to respond to requests made from the Mobile App. At this point, it can receive the order to send the current worklist to the Mobile, to receive images from the Mobile or, otherwise, disable any Bluetooth connection by turning the Bluetooth OFF in the Navigation bar.

Transfering Worklist[edit]

ARIS is sending to the Mobile App that has made the request the list of test identifiers from those Analytical tests which are in Processing state and marked as Automatic, known as worklist. Once the transfer is done, ARIS goes back to Waiting state.

Receiving Images[edit]

ARIS is receiving the images taken from one or more of those previously sent tests, captured with the Mobile App through the microscope. Every test in the set of images can have as many images as needed. Once the last image of a test is received, the model is executed in parallel for all of the images from that test. Meanwhile, ARIS can keep receiving images of other tests, or go back to Waiting state if no more images are being transferred.

Executing Model[edit]

ARIS is running the AI Model for all of the previously received images of an Analytical test, in order to automatically analyze them and obtain a diagnosis.