Skip to content

Environment Variables

Hibou environment variables allow you to edit your server setup configuration and customize it.

Updating your Appwrite environment variables requires you to edit your Hibou .env file.

Audio

NameDescriptionDefault
AUDIO_ANGLE_COVERAGEAngle in degree covered by the mics.60
AUDIO_STREAM_LATENCYAudio latency between the source and sink pads in ms.50
AUDIO_CHUNK_DURATIONDuration in ms of one audio chunk.500
AUDIO_VOLUMEBased software volume.9
AUDIO_REC_HZsampling frequency for recorded audio16000

Recordings

NameDescriptionDefault
REC_AUDIO_ENABLEWhen true, enables audio recording by channels in the output directory.true
REC_VIDEO_ENABLEWhen true, enables video recording by channels in the output directoryfalse
REC_VIDEO_ON_DETECTIONWhen true, videos are saved by channels in the output directory upon detection.false
REC_SAVE_FPDirectory where video are recorded../recs

ADC devices

NameDescriptionDefault
DEVICES_CONFIG_PATHFile path to where device should be loaded from a file../controllers_devices.json

Sound Processing

NameDescriptionDefault
STATIONARYWhen the noise reduction stationary is used.true

Logs

NameDescriptionDefault
LOG_PATHDirectory where logs are saved../logs/app.log
LOG_CONF_PATHLogging configuration for Python.logging.conf
LOG_LEVELLogging debug level. Possible values: DEBUG, INFO, WARNING, ERROR, CRITICAL, NOTSET.INFO

PTZ

NameDescriptionDefault
PTZ_USERNAMEPTZ username. Leave empty to skip initializationNone
PTZ_PASSWORDPTZ password. Leave empty to skip initializationNone
PTZ_HOSTPTZ host name address. Leave empty to skip initializationNone
PTZ_VIDEO_CHANNELCan be either: 1, 2, 31
PTZ_RTSP_PORTRTSP port for video stream.554
PTZ_START_AZIMUTHinitial azimuth angle of the camera.1770
PTZ_END_AZIMUTHfinal azimuth angle of a predefined movement.2793

AI

NameDescriptionDefault
AI_DEVICEAI's models can either run on CPU (cpu) or GPU (cuda).cpu
AI_NUM_PROCNumber of processors used by AI.4
AI_CV_ENABLEWhen computer vision detection is enable.false
AI_CV_MODELDirectory where model of computer vision is saved.yolo11n_drone.pt
AI_CV_MODEL_TYPEThe computer vision model usedyolo
AI_MODELS_FOLDERDirectory where AI models are saved./assets/audio_models/

IPC

NameDescriptionDefault
IPC_PROXY_XSUB_PORTZMQ proxy XSUB socket port5556
IPC_PROXY_XPUB_PORTZMQ proxy XPUB socket port5557
IPC_ACOUSTIC_ANGLE_TOPICIPC topic for angles detected by the acoustic module"acoustic_angle"
IPC_ACOUSTIC_DETECTION_TOPICIPC topic for detections from the acoustic module"acoustic_detection"
IPC_DECISION_ANGLE_TOPICIPC topic for angles output by the decision module"decision_angle"
IPC_DECISION_DETECTION_TOPICIPC topic for detections output by the decision module"decision_detection"
IPC_VISION_DECISION_TOPICIPC topic for decisions output by the vision module"vision_decision"
IPC_VISION_DETECTION_TOPICIPC topic for detections output by the vision module"vision_detection"
IPC_VISION_ANGLE_TOPICIPC topic for angles output by the vision module"vision_angle"
IPC_VIDEO_STREAMING_ANNOTATED_PORTPort for the annotated video stream5560
IPC_SYSTEM_STATUS_TOPICIPC topic for the overall system status"system_status"