Welcome to AppMAIS’s documentation!

Contents:

• Proxies
  • HealthStatuses
    • HealthStatuses.CRITICAL
    • HealthStatuses.NA
    • HealthStatuses.OK
    • HealthStatuses.UNKNOWN
    • HealthStatuses.WARNING
  • SettingSectionProxy
    • SettingSectionProxy._abc_impl
    • SettingSectionProxy._section_specific_configuration_values()
    • SettingSectionProxy._set_global_settings_with_section_overrides()
    • SettingSectionProxy._update_setting_on_proxy()
    • SettingSectionProxy.auto_start
    • SettingSectionProxy.capture_duration_seconds
    • SettingSectionProxy.capture_interval_seconds
    • SettingSectionProxy.capture_window_end_time
    • SettingSectionProxy.capture_window_start_time
    • SettingSectionProxy.configuration_values()
    • SettingSectionProxy.get_settings_section()
    • SettingSectionProxy.local_output_directory
    • SettingSectionProxy.logger
    • SettingSectionProxy.pytz_time_zone
    • SettingSectionProxy.root_upload_directory
    • SettingSectionProxy.setting_section_name
    • SettingSectionProxy.settings()
    • SettingSectionProxy.update_setting()
    • SettingSectionProxy.update_settings_section()
    • SettingSectionProxy.update_settings_section_in_memory()
  • SensorProxy
    • SensorProxy.auto_start
    • SensorProxy.capture_duration_seconds
    • SensorProxy.capture_interval_seconds
    • SensorProxy.capture_window_end_time
    • SensorProxy.capture_window_start_time
    • SensorProxy.dashboard_access_token
    • SensorProxy.dashboard_host
    • SensorProxy.get_all_recording_start_times_within_window()
    • SensorProxy.get_closest_previous_recording_start_time()
    • SensorProxy.get_closest_recording_start_time()
    • SensorProxy.get_closest_recording_time_with_tolerance()
    • SensorProxy.get_elapsed_recording_start_times()
    • SensorProxy.get_health_status()
    • SensorProxy.get_last_n_successful_recording_values()
    • SensorProxy.get_number_of_successful_recordings_on_date()
    • SensorProxy.local_output_directory
    • SensorProxy.read_csv()
    • SensorProxy.should_be_recording()
    • SensorProxy.should_have_recorded()
  • GlobalProxy
    • GlobalProxy.settings()
  • SFTPProxy
    • SFTPProxy.host
    • SFTPProxy.port
    • SFTPProxy.private_key_file_path
    • SFTPProxy.settings()
    • SFTPProxy.upload_delay
    • SFTPProxy.username
  • DashboardProxy
    • DashboardProxy.access_token
    • DashboardProxy.host
    • DashboardProxy.settings()
  • LogProxy
    • LogProxy.log_cycle_days
    • LogProxy.logging_level
    • LogProxy.max_archived_files
    • LogProxy.max_file_size_megabytes
    • LogProxy.settings()
  • AudioProxy
    • AudioProxy.channel_count
    • AudioProxy.gain
    • AudioProxy.read_csv()
    • AudioProxy.sample_format
    • AudioProxy.sampling_frequency
    • AudioProxy.settings()
  • VideoProxy
    • VideoProxy.flip_video
    • VideoProxy.frames_per_second
    • VideoProxy.read_csv()
    • VideoProxy.resolution_x
    • VideoProxy.resolution_y
    • VideoProxy.settings()
  • AirQualityProxy
    • AirQualityProxy.read_csv()
    • AirQualityProxy.settings()
  • TempProxy
    • TempProxy.read_csv()
    • TempProxy.settings()
  • ScaleProxy
    • ScaleProxy.read_csv()
    • ScaleProxy.settings()
    • ScaleProxy.weight_multiple
    • ScaleProxy.weight_offset
  • CPUProxy
    • CPUProxy.read_csv()
    • CPUProxy.settings()
• RPI API Documentation
• Beemon Server
• Beemon Client
  • Client
    • Client.close()
    • Client.connect()
    • Client.send()
    • Client.send_receive()
    • Client.wait_receive()
• Beemon Orchestrator
• 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:
  • The UploadHelper Class:
  • The UploadSession Class:
  • The UploaderHandler Class:
• Beemon Configuration Classes:
  • Config
    • Config.__ConfigInstance
      • Config.__ConfigInstance.__init__()
      • Config.__ConfigInstance.__weakref__
      • Config.__ConfigInstance.get()
      • Config.__ConfigInstance.get_raw()
      • Config.__ConfigInstance.write()
    • 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

Docstrings.

(The original entry is located in /github/workspace/api/proxies.py:docstring of proxies.SettingSectionProxy._section_specific_configuration_values, line 1.)

Todo

Docstring.

(The original entry is located in /github/workspace/api/proxies.py:docstring of proxies.SensorProxy.get_all_recording_start_times_within_window, line 23.)

Todo

Docstrings.

(The original entry is located in /github/workspace/api/proxies.py:docstring of proxies.SensorProxy.get_closest_recording_time_with_tolerance, line 4.)

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

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.)