Welcome to AppMAIS’s documentation!

Contents:

• Beemon Server
  • Server
    • Server.__init__()
    • Server._accept_loop()
    • Server.on_accept()
    • Server.on_receive()
    • Server.start()
    • Server.stop()
• Beemon Client
  • Client
    • Client.close()
    • Client.connect()
    • Client.send()
    • Client.send_receive()
    • Client.wait_receive()
• Beemon Orchestrator
  • Orchestrator
    • Orchestrator.__init__()
    • Orchestrator._auto_start_flagged_processes()
    • Orchestrator._auto_start_flagged_sensors()
    • Orchestrator._dynamically_initialize_sensors()
    • Orchestrator._handle_command()
    • Orchestrator._logger_compression()
    • Orchestrator._logger_rotation_check()
    • Orchestrator._populate_recording_start_time_queue_for_sensor()
    • Orchestrator.get_all_recording_start_times_within_window()
    • Orchestrator.halt_sensor()
    • Orchestrator.run()
    • Orchestrator.start_command()
    • Orchestrator.stop_command()
• Beemon Sensors
  • The Sensor Class:
    • Sensor
      • Sensor.__init__()
      • Sensor.__subclasshook__()
      • Sensor.record()
      • Sensor.run()
      • Sensor.start()
      • Sensor.transmit()
  • The Audio Class:
    • Audio
      • Audio.__init__()
      • Audio.make_stereo_file_mono()
      • Audio.record()
      • Audio.set_mic_gain()
      • Audio.start()
  • The Video Class:
    • Video
      • Video.__init__()
      • Video.record()
      • Video.start()
  • The Temp Class:
    • Temp
      • Temp.__init__()
      • Temp.record()
      • Temp.start()
  • The AirQuality Class:
    • AirQuality
      • AirQuality.__init__()
      • AirQuality._get_device_path()
      • AirQuality.record()
      • AirQuality.start()
  • The Scale Class:
    • Scale
      • Scale.__init__()
      • Scale.record()
      • Scale.start()
  • The Cpu Class:
    • Cpu
      • Cpu.__init__()
      • Cpu.record()
      • Cpu.start()
• Beemon Uploader
  • The Uploader Class:
    • Uploader
      • Uploader.__init__()
      • Uploader._handle_command()
      • Uploader.populate_secondary_queue()
      • Uploader.run()
      • Uploader.start()
      • Uploader.stop()
  • The UploadHelper Class:
    • UploadHelper
      • UploadHelper.__init__()
      • UploadHelper.make_directory()
      • UploadHelper.make_remote_directories()
      • UploadHelper.queue_upload()
      • UploadHelper.remove_local_file()
      • UploadHelper.run()
      • UploadHelper.stop()
      • UploadHelper.upload_file()
      • UploadHelper.upload_from_primary_queue()
      • UploadHelper.upload_from_secondary_queue()
  • The UploadSession Class:
    • UploadSession
      • UploadSession.__init__()
  • The UploaderHandler Class:
    • UploadHandler
      • UploadHandler.__init__()
      • UploadHandler.on_closed()
      • UploadHandler.on_created()
• Beemon Configuration Classes:
  • Config
    • Config.__ConfigInstance
      • Config.__ConfigInstance.__init__()
      • Config.__ConfigInstance.__weakref__
      • Config.__ConfigInstance.get()
      • Config.__ConfigInstance.get_raw()
    • Config.__init__()
    • Config.__weakref__
    • Config.parse_global_config()
    • Config.type_check()
• Utils
  • cleanup_local_sensor_output_directory()
  • write_sensor_csv_file()
• Import Utilities
  • get_classes_in_module()
  • parse_global_sensor_settings_from_config_file()
• Datetime Utilities:
  • convert_est_datetime_to_aware_utc_datetime()
  • convert_utc_datetime_to_est_timezone_aware_datetime()
  • military_time_to_cest_datetime_aware()
  • military_time_to_edt_datetime_aware()
  • military_time_to_utc_datetime_aware()
  • seconds_until_datetime()
• The SDS011 Class:
  • SDS011
    • SDS011.__init__()
    • SDS011.__weakref__
    • SDS011._execute()
    • SDS011._finish_cmd()
    • SDS011._get_reply()
    • SDS011._process_frame()
    • SDS011.cmd_begin()
    • SDS011.query()
    • SDS011.read()
    • SDS011.set_report_mode()
    • SDS011.set_work_period()
    • SDS011.sleep()

Indices and tables

• Index

• Module Index

• Search Page

Outstanding Documentation TODOs:

Todo

Docstring.

(The original entry is located in /github/workspace/src/beemon/client.py:docstring of client.Client.send, line 7.)

Todo

Docstring.

(The original entry is located in /github/workspace/src/beemon/client.py:docstring of client.Client.send_receive, line 4.)

Todo

Docstrings.

(The original entry is located in /github/workspace/src/beemon/configuration.py:docstring of configuration.Config, line 1.)

Todo

Docstrings.

(The original entry is located in /github/workspace/src/beemon/configuration.py:docstring of configuration.Config.__ConfigInstance, line 1.)

Todo

Docstrings.

(The original entry is located in /github/workspace/src/beemon/configuration.py:docstring of configuration.Config.__ConfigInstance.__init__, line 1.)

Todo

Docstrings, return type and type-hints.

(The original entry is located in /github/workspace/src/beemon/configuration.py:docstring of configuration.Config.__ConfigInstance.get, line 1.)

Todo

Docstrings, return types, and type-hints.

(The original entry is located in /github/workspace/src/beemon/configuration.py:docstring of configuration.Config.__ConfigInstance.get_raw, line 1.)

Todo

This functionality is not used anywhere. This method currently returns None.

(The original entry is located in /github/workspace/src/beemon/orchestrator.py:docstring of orchestrator.Orchestrator._handle_command, line 9.)

Todo

Docstring.

(The original entry is located in /github/workspace/src/beemon/orchestrator.py:docstring of orchestrator.Orchestrator.get_all_recording_start_times_within_window, line 23.)

Todo

Modify exit condition to be a stop() command received in addition to an empty queue.

(The original entry is located in /github/workspace/src/beemon/sensor.py:docstring of sensor.Sensor.run, line 7.)

Todo

Docstring.

(The original entry is located in /github/workspace/src/beemon/sensor.py:docstring of sensor.Audio.__init__, line 15.)

Todo

Docstring.

(The original entry is located in /github/workspace/src/beemon/sensor.py:docstring of sensor.Audio.__init__, line 21.)

Todo

Docstring.

(The original entry is located in /github/workspace/src/beemon/sensor.py:docstring of sensor.Audio.__init__, line 31.)

Todo

Docstring.

(The original entry is located in /github/workspace/src/beemon/sensor.py:docstring of sensor.Video.__init__, line 8.)

Todo

Docstring.

(The original entry is located in /github/workspace/src/beemon/sensor.py:docstring of sensor.Video.__init__, line 14.)

Todo

Docstring.

(The original entry is located in /github/workspace/src/beemon/sensor.py:docstring of sensor.Video.__init__, line 20.)

Todo

Docstring.

(The original entry is located in /github/workspace/src/beemon/sensor.py:docstring of sensor.Video.__init__, line 26.)

Todo

Docstrings.

(The original entry is located in /usr/local/lib/python3.12/site-packages/src/utils/datetimeutils.py:docstring of src.utils.datetimeutils.convert_est_datetime_to_aware_utc_datetime, line 1.)

Todo

Finish docstrings.

(The original entry is located in /usr/local/lib/python3.12/site-packages/src/utils/datetimeutils.py:docstring of src.utils.datetimeutils.convert_utc_datetime_to_est_timezone_aware_datetime, line 3.)

Todo

Docstrings.

(The original entry is located in /usr/local/lib/python3.12/site-packages/src/utils/datetimeutils.py:docstring of src.utils.datetimeutils.military_time_to_cest_datetime_aware, line 1.)

Todo

Docstrings.

(The original entry is located in /usr/local/lib/python3.12/site-packages/src/utils/datetimeutils.py:docstring of src.utils.datetimeutils.military_time_to_edt_datetime_aware, line 1.)

Todo

Docstrings.

(The original entry is located in /usr/local/lib/python3.12/site-packages/src/utils/datetimeutils.py:docstring of src.utils.datetimeutils.military_time_to_utc_datetime_aware, line 1.)

Todo

Docstrings.

(The original entry is located in /usr/local/lib/python3.12/site-packages/src/utils/datetimeutils.py:docstring of src.utils.datetimeutils.seconds_until_datetime, line 1.)