CHECK PERSONAL PROTECTIVE EQUIPMENT ======================================

ACTION DESCRIPTION
--------------------------------
This plugin provides :
- a "START CAMERA" workflow action, in order to start the camera.
- a "CAMERA FOR PERSONAL PROTECTIVE EQUIPMENT CHECK" element, used to capture the stream to analyse, the outputs are the camera datastream, the camera activation status, and the capture activation status.
- a "START LIVE PPE DETECTION” workflow action, to trigger the live PPE detection as a workflow start.
- a “STOP LIVE PPE DETECTION" workflow action, to stop the live detection.

The output of this plugin action is a list of each person detected in the video stream, an array of body parts (face, head, left-hand, right-hand) where the PPE has been detected, along with a summary containing the person(s) who properly wear the PPE against the requirements, and the ones who do not.

For each body part, an array of detected items of PPE is returned, including an indicator of whether or not the PPE covers the body part. The API returns the confidence it has in each detection (person, PPE, body part and body part coverage). It also returns a bounding box (BoundingBox) for each detected person and each detected item of PPE.

STEP-BY-STEP SETUP
--------------------------------
The steps from 0) to 1) can be automatically performed by using this deployment template:
 https://console.aws.amazon.com/cloudformation/home?#/stacks/create/review?stackName=BubbleRekognitionSyncOnly&templateURL=https://bubble-resources.s3.amazonaws.com/deployment-assets/CloudFormation-AWSRekognitionSyncOnly.yaml

 You will find the required parameters values used across the plugin in the "OUTPUT" tab of the created stack.

 0) Sign-up for AWS REKOGNITION by following this link: https://console.aws.amazon.com/rekognition/home?p=rkn&cp=bn&ad=c

 1) Create your AWS REKOGNITION API KEY & SECRET and attach the AWS REKOGNITION READ ONLY or FULL ACCESS POLICY to DETECTPROTECTIVEEQUIPMENT API: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys

 2) Enter in the PLUGIN SETTINGS your AWS REKOGNITION API KEY & SECRET & AWS SERVICE ENDPOINT REGION (if not provided, the default endpoint is "us-east-1").

 3) Add the "CAMERA FOR PERSONAL PROTECTIVE EQUIPMENT CHECK" element on your UI.

 4) Add a “START CAMERA” workflow action, in order to start the camera. Enter the Sampling Rate required for your use-case in milliseconds (2000 is a typical value).

 5) Add “START PERSONAL PROTECTIVE EQUIPMENT CHECK” as a new workflow start. This workflow is automatically triggered by the "CAMERA FOR PERSONAL PROTECTIVE EQUIPMENT CHECK" element action defined at step 3.

 6) Set up the "CHECK PERSONAL PROTECTIVE EQUIPMENT" plugin action in the workflow, set as input the "CAMERA FOR PERSONAL PROTECTIVE EQUIPMENT CHECK" data stream.
   Inputs Fields :
    - OUTPUT TYPE : Must always be set to “DETECTION (PROTECTIVE EQUIPMENT)
    - WEBCAM STREAM : Output of the “CAMERA FOR PERSONAL PROTECTIVE EQUIPMENT CHECK” element
    - MIN CONFIDENCE : Specifies the minimum confidence level for the required equipment. No equipment will be returned with confidence lower than this specified value. Minimum value of 0. Maximum value of 100. Default value is 80 if not provided.
    - FACE COVER : Specifies Face Cover as a required equipment.
    - HAND COVER : Specifies Hand Cover as a required equipment.
    - HEAD COVER : Specifies Head Cover as a required equipment.
   Output Fields :
    - RESULTS : Returns the list of 15 people maximum who are tested against the PPE's requirements you set, detected in the video stream, along with the parts of a body where the PPE is properly worn or not, and the types of detected PPEs (face cover, hand cover, and head cover).

 7) Add “STOP LIVE PPE CHECK” as a new workflow start to stop the live PPE check.

IMPLEMENTATION EXAMPLE
======================
Feel free to browse the app editor in the Service URL for an implementation example.

ADDITIONAL INFORMATION
======================

> AWS REKOGNITION service limits : https://docs.aws.amazon.com/rekognition/latest/dg/limits.html
> AWS services availability per region : https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services/
> AWS Service endpoints list : https://docs.aws.amazon.com/general/latest/gr/rande.html

TROUBLESHOOTING
================
Any plugin related error will be posted to the the Logs tab, "Server logs" section of your App Editor.
 Make sure that "Plugin server side output" and "Plugin server side output" is selected in "Show Advanced".

> Server Logs Details: https://manual.bubble.io/core-resources/bubbles-interface/logs-tab#server-logs

PERFORMANCE CONSIDERATIONS
===========================

GENERAL
-------------
 This implementation posts the file data to AWS.
 Therefore, the maximum allowable file size depends both on the bandwidth between Bubble.io & AWS, the highest limit being capped by Bubble.io's Workflow Action maximum execution time to perform this transfer operation.

QUESTIONS ?
===========
Contact us at [email protected] for any additional feature you would require or support question.