pepper.framework package¶
The Pepper Framework Package consists out of the basic building blocks to make robot applications.
Abstract¶
The framework.abstract package contains specifications for:
- Sensors:
AbstractCamera
AbstractMicrophone
- Actuators:
AbstractTextToSpeech
AbstractMotion
AbstractLed
- Backends & Applications:
AbstractBackend
AbstractApplication
- Components & Intentions:
AbstractComponent
AbstractIntention
Backend¶
The framework.backend package contains the backends implementing Sensors, Actuators & Backend:
NAOqiBackend
implements the backend for Pepper & Nao RobotsSystemBackend
implements the backend for Windows/Mac/Linux systems.
Sensor¶
The framework.sensor package implements Face, Object and Speech Recognition:
VAD
implements Voice Activity Detection on Microphone inputStreamedGoogleASR
implements Automated Speech Recognition through Google Speech APIObjectDetectionClient
connects to pepper_tensorflow for Object DetectionOpenFace
connects to the bamos/openface Docker container for Face RecognitionLocation
gets the current geographical location (WIP)
Component¶
Applications are made out of several instances of AbstractComponent
,
which expose various methods and events to applications. They’re summarized below:
CameraComponent
exposes theon_image()
event.MicrophoneComponent
exposes theon_audio()
event.SpeechRecognitionComponent
exposes theon_transcript()
event.ObjectDetectionComponent
exposes theon_object()
event.FaceRecognitionComponent
exposes theon_face()
,on_face_known()
&on_face_new()
events.TextToSpeechComponent
exposes thesay()
method.BrainComponent
exposespepper.brain.long_term_memory.LongTermMemory
to the application.
Some Components are more complex and require other components to work. They will raise a pepper.framework.abstract.component.ComponentDependencyError
if dependencies are not met.
ContextComponent
exposespepper.framework.context.Context
to the application and overrides thesay()
method to work with theChat
class. It also exposes theon_chat_turn()
,on_chat_enter()
&on_chat_exit()
events.StatisticsComponent
displays realtime system statistics in the command line.SceneComponent
creates a 3D scatterplot of the visible space.DisplayComponent
shows the live camera feedback and the 3D view of the current space, including the objects that are observed.
- pepper.framework.abstract package
- Abstract
- pepper.framework.abstract.application module
- pepper.framework.abstract.backend module
- pepper.framework.abstract.camera module
- pepper.framework.abstract.component module
- pepper.framework.abstract.intention module
- pepper.framework.abstract.led module
- pepper.framework.abstract.microphone module
- pepper.framework.abstract.motion module
- pepper.framework.abstract.tablet module
- pepper.framework.abstract.text_to_speech module
- pepper.framework.backend package
- Backend
- pepper.framework.backend.naoqi package
- pepper.framework.backend.naoqi.backend module
- pepper.framework.backend.naoqi.camera module
- pepper.framework.backend.naoqi.led module
- pepper.framework.backend.naoqi.microphone module
- pepper.framework.backend.naoqi.motion module
- pepper.framework.backend.naoqi.tablet module
- pepper.framework.backend.naoqi.text_to_speech module
- pepper.framework.backend.system package
- pepper.framework.backend.system.backend module
- pepper.framework.backend.system.camera module
- pepper.framework.backend.system.led module
- pepper.framework.backend.system.microphone module
- pepper.framework.backend.system.motion module
- pepper.framework.backend.system.tablet module
- pepper.framework.backend.system.text_to_speech module
- pepper.framework.component package
- Component
- pepper.framework.component.display package
- pepper.framework.component.brain module
- pepper.framework.component.camera module
- pepper.framework.component.context module
- pepper.framework.component.explore module
- pepper.framework.component.face_detection module
- pepper.framework.component.microphone module
- pepper.framework.component.object_detection module
- pepper.framework.component.scene module
- pepper.framework.component.speech_recognition module
- pepper.framework.component.statistics module
- pepper.framework.component.text_to_speech module
- pepper.framework.sensor package