VIC-14320 Add erase enrolled face event (#164)

Author: msintov

anki_vector/events.py

@@ -51,6 +51,7 @@ class Events(Enum):
     robot_observed_motion = "robot_observed_motion"                    #: Robot event dispatched when Vector observes motion.
     robot_observed_face = "robot_observed_face"                        #: Robot event for when a face is observed by the robot.
     robot_changed_observed_face_id = "robot_changed_observed_face_id"  #: Robot event for when a known face changes its id.
+    robot_erased_enrolled_face = "robot_erased_enrolled_face"          #: Robot event for when an enrolled face has been removed from the robot.
 
     wake_word = "wake_word"                             #: Robot event triggered when Vector hears "Hey Vector".
     user_intent = "user_intent"                         #: Robot event triggered after Vector processes voice commands.

anki_vector/faces.py

@@ -571,7 +571,7 @@ class FaceComponent(util.Component):
     """Manage the state of the faces on the robot."""
 
     @connection.on_connection_thread(requires_control=False)
-    async def request_enrolled_names(self) -> protocol.RequestEnrolledNamesRequest:
+    async def request_enrolled_names(self) -> protocol.RequestEnrolledNamesResponse:
         """Asks the robot for the list of names attached to faces that it can identify.
 
         .. testcode::
@@ -612,10 +612,24 @@ async def erase_enrolled_face_by_id(self, face_id: int):
 
         .. testcode::
 
+            import time
             import anki_vector
+            from anki_vector.events import Events
+
+            def on_robot_erased_enrolled_face(robot, event_type, event):
+                print(f"Face has been erased from robot. Event: {event_type} = {event}")
 
             with anki_vector.Robot() as robot:
-                robot.faces.erase_enrolled_face_by_id(1)
+                robot.events.subscribe(on_robot_erased_enrolled_face, Events.robot_erased_enrolled_face)
+
+                name_data_list = robot.faces.request_enrolled_names()
+                print(f"Enrolled names: {name_data_list}")
+
+                # Deletes all enrolled faces from Vector. Use with care!
+                for face in name_data_list.faces:
+                    robot.faces.erase_enrolled_face_by_id(face.face_id)
+
+                time.sleep(3)
         """
         req = protocol.EraseEnrolledFaceByIDRequest(face_id=face_id)
         return await self.grpc_interface.EraseEnrolledFaceByID(req)