pi-portal’s documentation

• Project Overview
• Project Requirements
  • Hardware
  • Python
  • PAAS Accounts
    • AWS Infrastructure
    • Logz.io Integration
  • Creating a configuration file
  • Installing The PI Portal Software
  • Logs and Slack Bot
• Installation Guide
  • Supervisord Warning
  • Docker Container
  • Raspberry PI OS
  • Other Linux Distributions
• CLI Summary
  • pi_portal.cli
• CLI Subcommand Reference
  • pi_portal.cli
    • cron_videos
    • door_monitor
    • install_config
    • slack_bot
    • temp_monitor
    • upload_snapshot
    • upload_video
    • version
• Configuration JSON Schema
• Slack Bot Setup Guide
• License
• Codebase Reference
  • pi_portal.cli
  • pi_portal.commands
    • pi_portal.commands.bases
      • pi_portal.commands.bases.command
        • CommandBase
          • CommandBase.invoke()
      • pi_portal.commands.bases.file_command
        • FileCommandBase
          • FileCommandBase.invoke()
    • pi_portal.commands.cron_videos
      • CronVideosCommand
        • CronVideosCommand.invoke()
        • CronVideosCommand.load_state()
    • pi_portal.commands.door_monitor
      • DoorMonitorCommand
        • DoorMonitorCommand.invoke()
        • DoorMonitorCommand.load_state()
    • pi_portal.commands.installer
      • InstallerCommand
        • InstallerCommand.invoke()
        • InstallerCommand.load_state()
    • pi_portal.commands.mixins
      • pi_portal.commands.mixins.state
        • CommandManagedStateMixin
          • CommandManagedStateMixin.load_state()
    • pi_portal.commands.slack_bot
      • SlackBotCommand
        • SlackBotCommand.invoke()
        • SlackBotCommand.load_state()
    • pi_portal.commands.temperature_monitor
      • TemperatureMonitorCommand
        • TemperatureMonitorCommand.invoke()
        • TemperatureMonitorCommand.load_state()
    • pi_portal.commands.upload_snapshot
      • UploadSnapshotCommand
        • UploadSnapshotCommand.invoke()
        • UploadSnapshotCommand.load_state()
    • pi_portal.commands.upload_video
      • UploadVideoCommand
        • UploadVideoCommand.invoke()
        • UploadVideoCommand.load_state()
    • pi_portal.commands.version
      • VersionCommand
        • VersionCommand.invoke()
  • pi_portal.config
  • pi_portal.conftest
  • pi_portal.installation
    • pi_portal.installation.installer
      • Installer
        • Installer.install()
    • pi_portal.installation.steps
      • pi_portal.installation.steps.bases
        • pi_portal.installation.steps.bases.base_step
          • StepBase
            • StepBase.invoke()
        • pi_portal.installation.steps.bases.remote_file_step
          • RemoteFile
          • RemoteFileDownloadError
            • RemoteFileDownloadError.with_traceback()
          • RemoteFileStepBase
            • RemoteFileStepBase.download()
            • RemoteFileStepBase.invoke()
        • pi_portal.installation.steps.bases.render_templates_step
          • RenderTemplateStepBase
            • RenderTemplateStepBase.invoke()
            • RenderTemplateStepBase.render()
        • pi_portal.installation.steps.bases.service_step
          • ServiceDefinition
          • ServiceStepBase
            • ServiceStepBase.disable()
            • ServiceStepBase.enable()
            • ServiceStepBase.invoke()
            • ServiceStepBase.start()
            • ServiceStepBase.stop()
        • pi_portal.installation.steps.bases.system_call_step
          • SystemCallBase
            • SystemCallBase.invoke()
          • SystemCallError
            • SystemCallError.with_traceback()
      • pi_portal.installation.steps.step_configure_logz_io
        • StepConfigureLogzIo
          • StepConfigureLogzIo.download()
          • StepConfigureLogzIo.invoke()
          • StepConfigureLogzIo.render()
      • pi_portal.installation.steps.step_ensure_root
        • StepEnsureRoot
          • StepEnsureRoot.invoke()
      • pi_portal.installation.steps.step_initialize_data_paths
        • StepInitializeDataPaths
          • StepInitializeDataPaths.invoke()
      • pi_portal.installation.steps.step_initialize_etc
        • StepInitializeEtc
          • StepInitializeEtc.invoke()
      • pi_portal.installation.steps.step_initialize_logging
        • StepInitializeLogging
          • StepInitializeLogging.invoke()
      • pi_portal.installation.steps.step_install_config_file
        • StepInstallConfigFile
          • StepInstallConfigFile.invoke()
      • pi_portal.installation.steps.step_kill_motion
        • StepKillMotion
          • StepKillMotion.disable()
          • StepKillMotion.enable()
          • StepKillMotion.invoke()
          • StepKillMotion.start()
          • StepKillMotion.stop()
      • pi_portal.installation.steps.step_kill_supervisor
        • StepKillSupervisor
          • StepKillSupervisor.disable()
          • StepKillSupervisor.enable()
          • StepKillSupervisor.invoke()
          • StepKillSupervisor.start()
          • StepKillSupervisor.stop()
      • pi_portal.installation.steps.step_render_configuration
        • StepRenderConfiguration
          • StepRenderConfiguration.invoke()
          • StepRenderConfiguration.render()
      • pi_portal.installation.steps.step_start_supervisor
        • StepStartSupervisor
          • StepStartSupervisor.disable()
          • StepStartSupervisor.enable()
          • StepStartSupervisor.invoke()
          • StepStartSupervisor.start()
          • StepStartSupervisor.stop()
    • pi_portal.installation.templates
      • pi_portal.installation.templates.config_file
        • ConfileFileTemplate
          • ConfileFileTemplate.create_context()
          • ConfileFileTemplate.render()
  • pi_portal.modules
    • pi_portal.modules.configuration
      • pi_portal.modules.configuration.logging
        • pi_portal.modules.configuration.logging.bases
          • pi_portal.modules.configuration.logging.bases.base_logger
            • LoggerConfigurationBase
              • LoggerConfigurationBase.configure()
              • LoggerConfigurationBase.configure_formatter()
              • LoggerConfigurationBase.configure_handler()
        • pi_portal.modules.configuration.logging.conftest
          • mocked_logger_name()
          • mocked_stream()
        • pi_portal.modules.configuration.logging.formatters
          • pi_portal.modules.configuration.logging.formatters.json
            • JsonFormatter
              • JsonFormatter.add_fields()
              • JsonFormatter.converter()
              • JsonFormatter.format()
              • JsonFormatter.formatException()
              • JsonFormatter.formatStack()
              • JsonFormatter.formatTime()
              • JsonFormatter.jsonify_log_record()
              • JsonFormatter.parse()
              • JsonFormatter.process_log_record()
              • JsonFormatter.serialize_log_record()
              • JsonFormatter.usesTime()
        • pi_portal.modules.configuration.logging.installer
          • InstallerLoggerConfiguration
            • InstallerLoggerConfiguration.configure()
            • InstallerLoggerConfiguration.configure_formatter()
            • InstallerLoggerConfiguration.configure_handler()
        • pi_portal.modules.configuration.logging.json
          • JsonLoggerConfiguration
            • JsonLoggerConfiguration.configure()
            • JsonLoggerConfiguration.configure_formatter()
            • JsonLoggerConfiguration.configure_handler()
      • pi_portal.modules.configuration.state
        • State
          • State.load()
          • State.log_level
      • pi_portal.modules.configuration.user_config
        • TypeUserConfig
        • TypeUserConfigGPIO
        • TypeUserConfigTemperatureSensors
        • UserConfiguration
          • UserConfiguration.load()
          • UserConfiguration.load_json_file()
          • UserConfiguration.validate()
        • UserConfigurationException
          • UserConfigurationException.with_traceback()
    • pi_portal.modules.integrations
      • pi_portal.modules.integrations.folder
        • pi_portal.modules.integrations.folder.queue
          • DiskQueueIterator
      • pi_portal.modules.integrations.gpio
        • pi_portal.modules.integrations.gpio.bases
          • pi_portal.modules.integrations.gpio.bases.monitor_factory
            • MonitorFactoryBase
              • MonitorFactoryBase.create()
          • pi_portal.modules.integrations.gpio.bases.sensor_factory
            • SensorFactoryBase
              • SensorFactoryBase.create()
        • pi_portal.modules.integrations.gpio.components
          • pi_portal.modules.integrations.gpio.components.bases
            • pi_portal.modules.integrations.gpio.components.bases.input
              • GPIOInputBase
                • GPIOInputBase.has_changed()
                • GPIOInputBase.hook_setup_input()
                • GPIOInputBase.hook_update_state()
                • GPIOInputBase.poll()
                • GPIOInputBase.sensor_type
            • pi_portal.modules.integrations.gpio.components.bases.monitor
              • GPIOMonitorBase
                • GPIOMonitorBase.check_state_for_changes()
                • GPIOMonitorBase.configure_logger()
                • GPIOMonitorBase.hook_log_state()
                • GPIOMonitorBase.hook_setup_gpio()
                • GPIOMonitorBase.is_running()
                • GPIOMonitorBase.start()
                • GPIOMonitorBase.update_state()
            • pi_portal.modules.integrations.gpio.components.bases.sensor
              • GPIOSensorBase
                • GPIOSensorBase.has_changed()
                • GPIOSensorBase.hook_setup_hardware()
                • GPIOSensorBase.hook_setup_input()
                • GPIOSensorBase.hook_update_state()
                • GPIOSensorBase.poll()
                • GPIOSensorBase.sensor_type
            • pi_portal.modules.integrations.gpio.components.bases.temperature_sensor
              • TemperatureSensor
                • TemperatureSensor.has_changed()
                • TemperatureSensor.hook_setup_hardware()
                • TemperatureSensor.hook_setup_input()
                • TemperatureSensor.hook_update_state()
                • TemperatureSensor.poll()
                • TemperatureSensor.sensor_type
              • TypeTemperatureData
          • pi_portal.modules.integrations.gpio.components.contact_switch
            • ContactSwitch
              • ContactSwitch.has_changed()
              • ContactSwitch.hook_setup_input()
              • ContactSwitch.hook_update_state()
              • ContactSwitch.poll()
              • ContactSwitch.sensor_type
          • pi_portal.modules.integrations.gpio.components.dht11_sensor
            • DHT11
              • DHT11.has_changed()
              • DHT11.hook_board_pin()
              • DHT11.hook_setup_hardware()
              • DHT11.hook_setup_input()
              • DHT11.hook_update_state()
              • DHT11.poll()
              • DHT11.sensor_type
          • pi_portal.modules.integrations.gpio.components.door_monitor
            • DoorMonitor
              • DoorMonitor.check_state_for_changes()
              • DoorMonitor.configure_logger()
              • DoorMonitor.hook_log_state()
              • DoorMonitor.hook_setup_gpio()
              • DoorMonitor.is_running()
              • DoorMonitor.start()
              • DoorMonitor.update_state()
            • DoorState
          • pi_portal.modules.integrations.gpio.components.temperature_monitor
            • TemperatureSensorMonitor
              • TemperatureSensorMonitor.check_state_for_changes()
              • TemperatureSensorMonitor.configure_logger()
              • TemperatureSensorMonitor.hook_log_state()
              • TemperatureSensorMonitor.hook_setup_gpio()
              • TemperatureSensorMonitor.is_running()
              • TemperatureSensorMonitor.start()
              • TemperatureSensorMonitor.update_state()
        • pi_portal.modules.integrations.gpio.door_monitor_factory
          • DoorMonitorFactory
            • DoorMonitorFactory.create()
        • pi_portal.modules.integrations.gpio.temperature_monitor_factory
          • TemperatureMonitorFactory
            • TemperatureMonitorFactory.create()
        • pi_portal.modules.integrations.gpio.temperature_sensor_factory
          • TemperatureSensorFactory
            • TemperatureSensorFactory.create()
      • pi_portal.modules.integrations.log_file
        • pi_portal.modules.integrations.log_file.temperature_monitor_logfile
          • TemperatureMonitorLogFileReader
            • TemperatureMonitorLogFileReader.read_last_values()
            • TemperatureMonitorLogFileReader.tail()
      • pi_portal.modules.integrations.motion
        • pi_portal.modules.integrations.motion.client
          • MotionClient
            • MotionClient.cleanup_snapshot()
            • MotionClient.get_latest_video_filename()
            • MotionClient.take_snapshot()
          • MotionException
            • MotionException.with_traceback()
      • pi_portal.modules.integrations.network
        • pi_portal.modules.integrations.network.http
          • HttpClient
            • HttpClient.get()
          • HttpClientError
            • HttpClientError.with_traceback()
      • pi_portal.modules.integrations.s3
        • pi_portal.modules.integrations.s3.bases
          • pi_portal.modules.integrations.s3.bases.cron
            • S3UploadCronJobBase
              • S3UploadCronJobBase.configure_logger()
              • S3UploadCronJobBase.start()
        • pi_portal.modules.integrations.s3.client
          • S3BucketClient
            • S3BucketClient.upload()
          • S3BucketException
            • S3BucketException.with_traceback()
        • pi_portal.modules.integrations.s3.video_upload_cron
          • VideoUploadCron
            • VideoUploadCron.configure_logger()
            • VideoUploadCron.start()
      • pi_portal.modules.integrations.slack
        • pi_portal.modules.integrations.slack.bot
          • SlackBot
            • SlackBot.configure_logger()
            • SlackBot.connect()
            • SlackBot.handle_command()
            • SlackBot.handle_event()
          • TypeSlackBoltEvent
        • pi_portal.modules.integrations.slack.cli
          • pi_portal.modules.integrations.slack.cli.commands
            • pi_portal.modules.integrations.slack.cli.commands.bases
              • pi_portal.modules.integrations.slack.cli.commands.bases.command
                • SlackCommandBase
                  • SlackCommandBase.invoke()
              • pi_portal.modules.integrations.slack.cli.commands.bases.process_command
                • SlackProcessCommandBase
                  • SlackProcessCommandBase.hook_invoker()
                  • SlackProcessCommandBase.hook_supervisor_exception()
                  • SlackProcessCommandBase.invoke()
              • pi_portal.modules.integrations.slack.cli.commands.bases.process_management_command
                • SlackProcessManagementCommandBase
                  • SlackProcessManagementCommandBase.hook_invoker()
                  • SlackProcessManagementCommandBase.hook_supervisor_exception()
                  • SlackProcessManagementCommandBase.hook_supervisor_process_exception()
                  • SlackProcessManagementCommandBase.invoke()
              • pi_portal.modules.integrations.slack.cli.commands.bases.process_status_command
                • SlackProcessStatusCommandBase
                  • SlackProcessStatusCommandBase.hook_invoker()
                  • SlackProcessStatusCommandBase.hook_supervisor_exception()
                  • SlackProcessStatusCommandBase.invoke()
              • pi_portal.modules.integrations.slack.cli.commands.bases.process_uptime_command
                • SlackProcessUptimeCommandBase
                  • SlackProcessUptimeCommandBase.hook_invoker()
                  • SlackProcessUptimeCommandBase.hook_supervisor_exception()
                  • SlackProcessUptimeCommandBase.invoke()
            • pi_portal.modules.integrations.slack.cli.commands.command_arm
              • ArmCommand
                • ArmCommand.hook_invoker()
                • ArmCommand.hook_supervisor_exception()
                • ArmCommand.hook_supervisor_process_exception()
                • ArmCommand.invoke()
            • pi_portal.modules.integrations.slack.cli.commands.command_disarm
              • DisarmCommand
                • DisarmCommand.hook_invoker()
                • DisarmCommand.hook_supervisor_exception()
                • DisarmCommand.hook_supervisor_process_exception()
                • DisarmCommand.invoke()
            • pi_portal.modules.integrations.slack.cli.commands.command_help
              • HelpCommand
                • HelpCommand.invoke()
            • pi_portal.modules.integrations.slack.cli.commands.command_id
              • IDCommand
                • IDCommand.invoke()
            • pi_portal.modules.integrations.slack.cli.commands.command_restart
              • RestartCommand
                • RestartCommand.invoke()
            • pi_portal.modules.integrations.slack.cli.commands.command_snapshot
              • SnapshotCommand
                • SnapshotCommand.hook_invoker()
                • SnapshotCommand.hook_supervisor_exception()
                • SnapshotCommand.invoke()
            • pi_portal.modules.integrations.slack.cli.commands.command_status
              • StatusCommand
                • StatusCommand.hook_invoker()
                • StatusCommand.hook_supervisor_exception()
                • StatusCommand.invoke()
            • pi_portal.modules.integrations.slack.cli.commands.command_temperature
              • TemperatureCommand
                • TemperatureCommand.invoke()
            • pi_portal.modules.integrations.slack.cli.commands.command_uptime
              • UptimeCommand
                • UptimeCommand.invoke()
            • pi_portal.modules.integrations.slack.cli.commands.process_uptime_commands
              • pi_portal.modules.integrations.slack.cli.commands.process_uptime_commands.cron_videos_uptime
                • CronVideosUptimeCommand
                  • CronVideosUptimeCommand.hook_invoker()
                  • CronVideosUptimeCommand.hook_supervisor_exception()
                  • CronVideosUptimeCommand.invoke()
              • pi_portal.modules.integrations.slack.cli.commands.process_uptime_commands.door_monitor_uptime
                • DoorMonitorUptimeCommand
                  • DoorMonitorUptimeCommand.hook_invoker()
                  • DoorMonitorUptimeCommand.hook_supervisor_exception()
                  • DoorMonitorUptimeCommand.invoke()
              • pi_portal.modules.integrations.slack.cli.commands.process_uptime_commands.slack_bot_uptime
                • BotUptimeCommand
                  • BotUptimeCommand.hook_invoker()
                  • BotUptimeCommand.hook_supervisor_exception()
                  • BotUptimeCommand.invoke()
              • pi_portal.modules.integrations.slack.cli.commands.process_uptime_commands.temp_monitor_uptime
                • TempMonitorUptimeCommand
                  • TempMonitorUptimeCommand.hook_invoker()
                  • TempMonitorUptimeCommand.hook_supervisor_exception()
                  • TempMonitorUptimeCommand.invoke()
          • pi_portal.modules.integrations.slack.cli.handler
            • SlackCLICommandHandler
              • SlackCLICommandHandler.command_arm()
              • SlackCLICommandHandler.command_disarm()
              • SlackCLICommandHandler.command_help()
              • SlackCLICommandHandler.command_id()
              • SlackCLICommandHandler.command_restart()
              • SlackCLICommandHandler.command_snapshot()
              • SlackCLICommandHandler.command_status()
              • SlackCLICommandHandler.command_temp()
              • SlackCLICommandHandler.command_uptime()
              • SlackCLICommandHandler.handle()
          • pi_portal.modules.integrations.slack.cli.notifier
            • SlackCLINotifier
              • SlackCLINotifier.notify_already_start()
              • SlackCLINotifier.notify_already_stop()
              • SlackCLINotifier.notify_error()
              • SlackCLINotifier.notify_start()
              • SlackCLINotifier.notify_stop()
          • get_available_commands()
        • pi_portal.modules.integrations.slack.client
          • SlackClient
            • SlackClient.configure_logger()
            • SlackClient.send_file()
            • SlackClient.send_message()
            • SlackClient.send_snapshot()
        • pi_portal.modules.integrations.slack.config
          • SlackClientConfiguration
    • pi_portal.modules.mixins
      • pi_portal.modules.mixins.json_file
        • JSONFileReader
          • JSONFileReader.load_json_file()
      • pi_portal.modules.mixins.read_log_file
        • LogFileReader
          • LogFileReader.tail()
      • pi_portal.modules.mixins.write_log_file
        • LogFileWriter
          • LogFileWriter.configure_logger()
    • pi_portal.modules.python
      • pi_portal.modules.python.metadata
      • pi_portal.modules.python.mock
      • pi_portal.modules.python.rpi
        • pi_portal.modules.python.rpi.patch
          • patch_module()
      • pi_portal.modules.python.xmlrpc
    • pi_portal.modules.system
      • pi_portal.modules.system.file_security
        • FileSecurity
          • FileSecurity.sha256()
        • FileSecurityViolation
          • FileSecurityViolation.with_traceback()
      • pi_portal.modules.system.linux
        • uptime()
      • pi_portal.modules.system.socket
        • pi_portal.modules.system.socket.unix_stream_http_connection
          • UnixStreamHTTPConnection
            • UnixStreamHTTPConnection.close()
            • UnixStreamHTTPConnection.connect()
            • UnixStreamHTTPConnection.endheaders()
            • UnixStreamHTTPConnection.getresponse()
            • UnixStreamHTTPConnection.putheader()
            • UnixStreamHTTPConnection.putrequest()
            • UnixStreamHTTPConnection.request()
            • UnixStreamHTTPConnection.response_class
            • UnixStreamHTTPConnection.send()
            • UnixStreamHTTPConnection.set_tunnel()
        • pi_portal.modules.system.socket.unix_stream_transport
          • UnixStreamTransport
            • UnixStreamTransport.make_connection()
      • pi_portal.modules.system.supervisor
        • SupervisorClient
          • SupervisorClient.start()
          • SupervisorClient.start_time()
          • SupervisorClient.status()
          • SupervisorClient.stop()
        • SupervisorException
          • SupervisorException.with_traceback()
        • TypeSupervisorProcessInfo
      • pi_portal.modules.system.supervisor_config
        • ProcessList
        • ProcessStatus
      • pi_portal.modules.system.supervisor_process
        • SupervisorProcess
          • SupervisorProcess.start()
          • SupervisorProcess.status()
          • SupervisorProcess.status_in()
          • SupervisorProcess.stop()
          • SupervisorProcess.uptime()
        • SupervisorProcessException
          • SupervisorProcessException.with_traceback()

Indices and tables

• Index

• Module Index

• Search Page