facepass-react-native-module

Face Recognition Module for React Native

Changelog

See changelog.md file for detailed release notes.

Installation

npm install facepass-react-native-module

Require use of any package that allow react native to save and retrieve data, the data need to store as JSON.

DefaultPreference is the example of package in this documentation,you can freely choose other package to be used Android

Important

From version 0.1.33 onward this is required:

-inside android/build.gradle

  allprojects {
    repositories {
      ...
      flatDir { dirs "$rootDir/../node_modules/facepass-react-native-module/android/libs"}
    }
  }

• In android/app/src/main/AndroidManifest.xml

  <uses-feature
        android:name="android.hardware.camera"
        android:required="true" />
  <uses-permission android:name="android.permission.CAMERA" />
  <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
  <uses-permission android:name="android.permission.MOUNT_UNMOUNT_FILESYSTEMS" />

  <application>
    ....
   <service android:name="com.fppreactnativemodule.TemperatureService" android:enabled="true"/>   <!--   Add this   -->
  </application>

Usage

React Native

• App.js/Index.js

-For list of function name refer to document below
  import { FunctionName } from 'facepass-react-native-module';

-Example,
  import { cameraSetting, setDefaultGroupName, initData } from 'facepass-react-native-module';
  
  export default function App(){
    useEffect(()=>{
      async function init() {
        //DefaultPreference is the example package used to store data in this example,can choose whatever package you like
        const setting = await DefaultPreference.get("parameters")
        const camera = await DefaultPreference.get("settings")

        //Check and create a default group if no group is exist
        let group = "default";
        try {
          const success = await initData(JSON.parse(setting))
          try {
            const temp_group = await DefaultPreference.get("group_name")
            if (temp_group != null) {
              group = temp_group;
            }
            try {
              const check = await checkGroupExist(group)
            } catch (e) {
              try {
                const create = await createGroup(group)
               DefaultPreference.set("group_name",group)
              } catch (e) {
                  //Create group error
              }
            }
          } catch (e) {
            //Get group_name error
          }
        } catch (e) {
          //Init error
        }
        cameraSetting(JSON.parse(camera));
        setDefaultGroupName(group);

        setIsLoading(false)
    }
  
    init()
    },[])
 
  }

• MainScreen.js(Can be any name,The page you want to display the face recognition screen,can also be in App.js)

  import { StyleSheet,View,PixelRatio,UIManager,findNodeHandle,BackHandler, NativeEventEmitter } from 'react-native';
  import { useEffect,useRef } from 'react';
  import { FacePassViewManager,FacePass } from 'facepass-react-native-module';
  import { useIsFocused } from '@react-navigation/native';

• Outside function MainScreen of MainScreen.js

  const createFragment = viewId =>
    UIManager.dispatchViewManagerCommand(
      viewId,
      // we are calling the 'create' command
      UIManager.FacePassViewManager.Commands.create.toString(),
      [viewId],
    );
  const destroyFragment = viewId =>
    UIManager.dispatchViewManagerCommand(
      viewId,
    // we are calling the 'create' command
    UIManager.FacePassViewManager.Commands.remove.toString(),
    [viewId],
  );

• Inside function MainScreen of MainScreen.js

 const eventEmitter = new NativeEventEmitter(FacePass);
 const ref = useRef(null);

   useEffect(() => {
       const viewId = findNodeHandle(ref.current);

       if (isFocused) {
           createFragment(viewId);
       } else {
           destroyFragment(viewId);
       }
   }, [isFocused]);



 // Add an event listener to receive the data
 useEffect(()=>{
     const dataListener = eventEmitter.addListener('FaceDetectedEvent', async (params) => {
       //Do something here,e.g.
       const faceToken = params.faceToken;
       //List of data:
         //image //image in base64 format
         //faceToken //use to get image/as an id to recognize a person identidy
         //trackID //ID number of tracking ,for reference
         //searchScore //percentage it match the detected face
         //searchThreshold //percentage required for the application to say the face match the detected face
         //hairType //0-5,BALD, LITTLE_HAIR, SHORT_HAIR, LONG_HAIR, UNKNOWN, INVALID
         //beardType //0-4, NO_BEARD, MOUSTACHE, WHISKER, UNKNOWN, INVALID
         //hatType //0-4, NO_HAT, SAFETY_HELMET, OTHERS, UNKNOWN, INVALID
         //respiratorType //0-4,  COVER_MOUTH_NOSE, COVER_MOUTH, NO_RESPIRATOR, UNKNOWN, INVALID
         //glassesType //0-4,  NO_GLASSES, GLASSES_WITH_DARK_FRAME, GLASSES_OTHERS, UNKNOWN, INVALID
         //skinColorType //0-4, YELLOW, WHITE, BLACK, BROWN, INVALID
     });

   const stopListener = eventEmitter.addListener(
     'FaceDetectedEndEvent', async () => {
         //Do something after recognition such as remove the result view
     }
   )
   const unknownFaceListener= eventEmitter.addListener(
     'UnknownFaceDetectedEvent',
     async(params) =>{
       //Do something here,e.g.
       const image=params.image;
       //List of data:
         //image //image in base64 format
         //trackID //ID number of tracking ,for reference
         //searchScore //percentage it match the detected face ,  //may not available if no face in local group
         //searchThreshold //percentage required for the application to say the face match the detected face, //may not available if no face in local group
         //hairType //0-5,BALD, LITTLE_HAIR, SHORT_HAIR, LONG_HAIR, UNKNOWN, INVALID
         //beardType //0-4, NO_BEARD, MOUSTACHE, WHISKER, UNKNOWN, INVALID
         //hatType //0-4, NO_HAT, SAFETY_HELMET, OTHERS, UNKNOWN, INVALID
         //respiratorType //0-4,  COVER_MOUTH_NOSE, COVER_MOUTH, NO_RESPIRATOR, UNKNOWN, INVALID
         //glassesType //0-4,  NO_GLASSES, GLASSES_WITH_DARK_FRAME, GLASSES_OTHERS, UNKNOWN, INVALID
         //skinColorType //0-4, YELLOW, WHITE, BLACK, BROWN, INVALID
     }
   )

   const qrDetectListener = eventEmitter.addListener(
     'QRDetectedEvent',
     async (params) => {
       console.log(params);
     }
   )

   return () => {
     // Clean up and remove event listeners
     dataListener.remove();
     stopListener.remove();
     unknownFaceListener.remove();
     qrDetectListener.remove();
   };
   
 },[])
 return (
   <FacePassViewManager
     style={{
       // converts dpi to px, provide desired height
       height: PixelRatio.getPixelSizeForLayoutSize(
         yourheight,e.g. 500
       ),
       // converts dpi to px, provide desired width
       width: PixelRatio.getPixelSizeForLayoutSize(
         yourwidth,e.g. 500
       ),
     }}
     ref={ref}
     />
 );

*** Other function(FacePass related) ***

• Get a list of group name

  try{
    const data=await getAllGroup()
  }catch(error){
    //Error message
  }

• Create a new group with provided name

  try{
    const successMessage=await createGroup(name)
  }catch(error){
    //Error message
  }

• Delete the group with provided name

  try{
    const groupListArray =await deleteGroup(name)
  }catch(error){
    //Error message
  }

• Open file explorer and choose image

  try{
    const imagePath=await selectImage()
  }catch(error){
    //Error message
  }

• Add selected face into facial recognition

  try{
    const faceToken=await addFace(imagePath)
    
    //Image path can be wherether local path or an url image
    //Here is to set the face owner name so that the app can know the face belong to who
    //"Face owner name" need to be replace with own function to get name,e.g an text field
    //DefaultPreference is the example package used to store data in this example,can choose whatever package you like
    
    DefaultPreference.set(faceToken, "Face owner name");
  }catch(error){
    //Error message
  }

• Delete selected face

  //faceToken is generated from addFace function
  //groupName= Name of group with that Face added
  try{
    const successMessage=await deleteFace("faceToken", "groupName")
    //Then delete face from local storage if got
  }catch(error){
    //Error message
  }

• Get the face using faceToken, return an image in base64 format

  try{
    //base64 image action,e.g. setImage(base64Image) , setImage is the useState() variable.
    const base64Image =await getFace("faceToken")
  }catch(e){
    //Error message
  }

• Get the path to face image using faceToken, return an string of path

  try{
    const path =await getFacePath("faceToken")
  }catch(e){
    //Error message
  }

• Bind to face to a group using faceToken and groupName

  try{
      const successMessage=await bindGroup("faceToken","groupName")
    }catch(e){
      //Error message
    }

• Get all facetoken from the provided groupname

  try{
    const faceTokenListArray=await getGroupInfo("groupName")
  }catch(e){
    //Error message
  }

• Unbind the faceToken from provided group

  try{
      const faceTokenListArray=await unbindFace("facetoken", "groupName")
    }catch(e){
      //Error message
    }

• Check if group exist

  try{
     const check = await checkGroupExist("groupname")
  }catch(e){
    //Error message
  }

• Set the time to show face recogntion(Optional)

  setRecognitionDisplayTime(time)
  //time= integer,in milli-second

• Control the light

  changeLight("color")
  //List of color:"red","green","white","yellow","off"
  //"off" is to turn off light,the light need to be turn off on app exit else will remain turn on

• Control the door(Not test yet)

  controlDoor("command")
  //Command: "open","close"

• Use IR camera as support for face recognition

  useIRCameraSupport(boolean)
  //Command: true/false

• Restart the device

  restartDevice()

• Enable IR camera preview

  enableIRPreview(boolean)
  //Command: true/false

• Enable QR scanner

  enableQRScan(boolean)
  //Command: true/false

-Enable/disable hiding of navigation bar

  hideNavigationBar(boolean)
  //Command: true/false

• Enable temperature detection(Untested)

  enableTemperature(boolean)
  //Command: true/false

• Change exposure Compensation

setExposureCompensation(value)
  //Command: 0-? depend on device

• Check if facepass done initialize

  const result=await checkDoneInitialize()
  //Return data:Boolean of true false

-Release / stop facepass handler

  try{
    await releaseFacePassHandler()
  }catch(err){
    //error message,usually because not initialized , no need to release
  }

-Pause/unpause face listener

pauseListener(boolean)
//true=pause,false=unpause

-Restart whole application

restartApplication()

-Get device serial number

const SN=await getDeviceSerialNumber()

JSON format of Parameter for funtion

• setDefaultGroupName()

    //function name can be change to anything
    //defaultGroupName need to get yourself
    //e.g. a text field
    //This default group is the group that will be
    load on min screen
    setDefaultGroupName("your_group_name")

• initData() -> this need to be call again when want to apply new parameter

  const json = {
    rcAttributeAndOcclusionMode: rcAttributeAndOcclusionMode, //0-5,whole number,Default:1
    searchThreshold: searchThreshold, //0-100,Default:69
    livenessThreshold: livenessThreshold, //0-100,Default:55
    livenessEnabled: livenessEnabled, //true,false,Default:true
    rgbIrLivenessEnabled: false, //Currently only can false
    poseThresholdRoll: poseThresholdRoll, //0-90,Default:35
    poseThresholdPitch: poseThresholdPitch, //0-90,Default:35
    poseThresholdYaw: poseThresholdYaw, //0-90,Default:35
    blurThreshold: blurThreshold, //0-1,Default:0.8
    lowBrightnessThreshold: lowBrightnessThreshold, //0-255,Default:30
    highBrightnessThreshold: highBrightnessThreshold, //0-255,Default:210
    brightnessSTDThreshold: brightnessSTDThreshold, //0-255,Default:80
    faceMinThreshold: faceMinThreshold, //0-512,whole number,Default:100
    retryCount: retryCount, //1-unlimited,whole number,Default:2
    smileEnabled: smileEnabled, //true/false,Default:false
    maxFaceEnabled: maxFaceEnabled, //true/false,Default:true
    FacePoseThresholdPitch: FacePoseThresholdPitch, //0-90,Default:35
    FacePoseThresholdRoll: FacePoseThresholdRoll, //0-90,Default:35
    FacePoseThresholdYaw: FacePoseThresholdYaw, //0-90,Default:35
    FaceBlurThreshold: FaceBlurThreshold, //0-255,Default:0.7
    FaceLowBrightnessThreshold: FaceLowBrightnessThreshold, //0-255,Default:70
    FaceHighBrightnessThreshold: FaceHighBrightnessThreshold, //0-255,Default:220
    FaceBrightnessSTDThreshold: FaceBrightnessSTDThreshold, //0-255,Default:60
    FaceFaceMinThreshold: FaceFaceMinThreshold, //0-512,whole number,Default:100
    FaceRcAttributeAndOcclusionMode: FaceRcAttributeAndOcclusionMode, //whole number //0-5,Default:2
    faceDetectMode:faceDetectMode,//whole number //0-2,Default:0, 0=normal mode,1=long range mode,2 = super long range mode, will affect detection speed
    ageGenderEnabled:ageGenderEnabled, //true,false,default:false
  }

  initData(json)

  //Recommended value
  initData({
    "rcAttributeAndOcclusionMode":1,"searchThreshold":69,"livenessThreshold":55,"livenessEnabled":false,"rgbIrLivenessEnabled":false,"poseThresholdRoll":35,"poseThresholdPitch":35,"poseThresholdYaw":35,"blurThreshold":0.8,"lowBrightnessThreshold":30,"highBrightnessThreshold":210,"brightnessSTDThreshold":80,"faceMinThreshold":100,"retryCount":2,"smileEnabled":false,"maxFaceEnabled":true,"FacePoseThresholdPitch":35,"FacePoseThresholdRoll":35,"FacePoseThresholdYaw":35,"FaceBlurThreshold":0.7,"FaceLowBrightnessThreshold":70,"FaceHighBrightnessThreshold":220,"FaceBrightnessSTDThreshold":60,"FaceFaceMinThreshold":100,"FaceRcAttributeAndOcclusionMode":2,faceDetectMode:"0",ageGenderEnabled:false
  })

• cameraSetting();

  const data = {
    cameraFacingFront: cameraFacingFront //true,false,Default:false,
    faceRotation: faceRotation //0,90,180,270,Default:90,
    isSettingAvailable: true,//Leave it like this
    cameraPreviewRotation: cameraPreviewRotation //0,90,180,270,Default:270,
    isCross: isCross //true,false,Default:false,
  }
  cameraSetting(data);

  //Recommended value     
  cameraSetting({
    "cameraFacingFront": false,
    "faceRotation": 90,
    "isSettingAvailable": true,
    "cameraPreviewRotation": 270,
    "isCross": true,
  });
        

• List of success/error code

FACEPASSHANDLER_NULL_ERROR //The face pass handler is not initialized,suggest to restart the app
IMAGE_SELECT_CANCELED_ERROR //User cancel the image selection
IMAGE_SELECT_FAIL_ERROR //Something wrong on image selected
ACTIVITY_NOT_EXIST_ERROR //Cannot get the current activity
IMAGE_NOT_EXIST_ERROR //The path does not contain image
INVALID_IMAGE_PATH_ERROR //The passed string not a valid path
FACE_ADDED_SUCCESSFULLY //Successfully add the face for face recognition
NO_FACE_DETECTED_IN_IMAGE_ERROR //The provided image does not contain face
FACE_IMAGE_QUALITY_ERROR  //The face image does not meet the required quality
NULL_GROUPNAME_ERROR  // Group name is null
FACE_DELETE_SUCCESS // Success to delete face
GROUP_NAME_IS_NULL_ERROR // Null input for group name
FACETOKEN_IS_NULL_ERROR //Empty facetoken
BIND_GROUP_SUCCESS // Successfully bind group
BIND_GROUP_FAILED //  Fail to bind group,probably the provided group not exist
GROUP_NAME_NOT_EXIST_ERROR // group with the provided group name is not exist
GET_LOCAL_GROUP_INFO_ERROR // fail to get group info,probably the provided group not exist
FACE_UNBIND_SUCCESS // Successfully unbind the face from group
FACE_UNBIND_FAILED // Fail to unbind face from group
EMPTY_LOCAL_GROUP_ERROR //  No local group found in the application.
EMPTY_GROUP_INPUT_ERROR // No group anme provided
GROUP_CREATION_SUCCESS  //Success in group creation
GROUP_CREATION_FAILED //Fail to create group
GROUP_DELETION_SUCCESS //group delete success

Known Issue

• Currently no

Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

License

MIT

Made with create-react-native-library