Welcome to Cleep’s API documentation!

Contents:

• cleep
  • cleep package
    • cleep.events package
      • cleep.events.coreappsupdatedevent module
        • CoreAppsUpdatedEvent
          • CoreAppsUpdatedEvent.EVENT_NAME
          • CoreAppsUpdatedEvent.EVENT_PARAMS
          • CoreAppsUpdatedEvent.EVENT_PROPAGATE
      • cleep.events.coredevicedeletedevent module
        • CoreDeviceDeletedEvent
          • CoreDeviceDeletedEvent.EVENT_NAME
          • CoreDeviceDeletedEvent.EVENT_PARAMS
          • CoreDeviceDeletedEvent.EVENT_PROPAGATE
    • cleep.libs package
      • cleep.libs.commands package
        • cleep.libs.commands.alsa module
        • cleep.libs.commands.blkid module
        • cleep.libs.commands.ifconfig module
        • cleep.libs.commands.ifupdown module
        • cleep.libs.commands.ip module
        • cleep.libs.commands.iw module
        • cleep.libs.commands.iwconfig module
        • cleep.libs.commands.iwgetid module
        • cleep.libs.commands.iwlist module
        • cleep.libs.commands.lsblk module
        • cleep.libs.commands.lsmod module
        • cleep.libs.commands.modprobe module
        • cleep.libs.commands.rfkill module
        • cleep.libs.commands.udevadm module
        • cleep.libs.commands.wpacli module
      • cleep.libs.configs package
        • cleep.libs.configs.appssources module
        • cleep.libs.configs.asoundrc module
        • cleep.libs.configs.cleepaudio module
        • cleep.libs.configs.cleepconf module
        • cleep.libs.configs.cleepwificonf module
        • cleep.libs.configs.cmdline module
        • cleep.libs.configs.cmdlinetxt module
        • cleep.libs.configs.config module
        • cleep.libs.configs.configtxt module
        • cleep.libs.configs.dhcpcdconf module
        • cleep.libs.configs.etcasoundconf module
        • cleep.libs.configs.etcmodules module
        • cleep.libs.configs.etcnetworkinterfaces module
        • cleep.libs.configs.fstab module
        • cleep.libs.configs.hostname module
        • cleep.libs.configs.modulesjson module
        • cleep.libs.configs.wpasupplicantconf module
      • cleep.libs.drivers package
        • cleep.libs.drivers.audiodriver module
        • cleep.libs.drivers.driver module
      • cleep.libs.internals package
        • cleep.libs.internals.cleepbackup module
          • CleepBackup
            • CleepBackup.BACKUP_PATH
            • CleepBackup.CLEEP_PATH
            • CleepBackup.backup()
            • CleepBackup.generate_archive()
        • cleep.libs.internals.cleepdoc module
        • cleep.libs.internals.cleepfilesystem module
        • cleep.libs.internals.cleepgithub module
          • CleepGithub
            • CleepGithub.GITHUB_RATE
            • CleepGithub.GITHUB_URL
            • CleepGithub.get_api_rate()
            • CleepGithub.get_release_assets_infos()
            • CleepGithub.get_release_changelog()
            • CleepGithub.get_release_version()
            • CleepGithub.get_releases()
            • CleepGithub.is_released()
        • cleep.libs.internals.cleepresource module
          • CleepResource
            • CleepResource.RESOURCE_NAME
        • cleep.libs.internals.console module
        • cleep.libs.internals.crashreport module
        • cleep.libs.internals.criticalresources module
        • cleep.libs.internals.download module
        • cleep.libs.internals.drivers module
        • cleep.libs.internals.event module
          • Event
            • Event.EVENT_CHARTABLE
            • Event.EVENT_JOURNALIZABLE
            • Event.EVENT_NAME
            • Event.EVENT_PARAMS
            • Event.EVENT_PROPAGATE
            • Event.get_chart_values()
            • Event.render()
            • Event.send()
            • Event.send_to_peer()
        • cleep.libs.internals.eventsbroker module
          • EventsBroker
            • EventsBroker.CORE_EVENTS_DIR
            • EventsBroker.MODULES_DIR
            • EventsBroker.PYTHON_CLEEP_APPS_IMPORT_PATH
            • EventsBroker.PYTHON_CLEEP_CORE_EVENTS_IMPORT_PATH
            • EventsBroker.configure()
            • EventsBroker.get_event_instance()
            • EventsBroker.get_module_events()
            • EventsBroker.get_modules_events()
            • EventsBroker.get_used_events()
            • EventsBroker.is_event_renderable()
            • EventsBroker.set_event_renderable()
        • cleep.libs.internals.externalbus module
          • ExternalBus
            • ExternalBus.COMMAND_RESPONSE_EVENT
            • ExternalBus.on_message_received()
            • ExternalBus.run()
            • ExternalBus.run_once()
            • ExternalBus.send_message()
        • cleep.libs.internals.install module
        • cleep.libs.internals.installcleep module
        • cleep.libs.internals.installdeb module
        • cleep.libs.internals.installmodule module
        • cleep.libs.internals.profileformatter module
          • ProfileFormatter
            • ProfileFormatter.format()
        • cleep.libs.internals.profileformattersbroker module
          • ProfileFormattersBroker
            • ProfileFormattersBroker.MODULES_DIR
            • ProfileFormattersBroker.PYTHON_CLEEP_IMPORT_PATH
            • ProfileFormattersBroker.configure()
            • ProfileFormattersBroker.get_renderers()
            • ProfileFormattersBroker.get_renderers_formatters()
            • ProfileFormattersBroker.get_renderers_profiles()
            • ProfileFormattersBroker.register_renderer()
        • cleep.libs.internals.readwrite module
        • cleep.libs.internals.rendererprofile module
          • RendererProfile
            • RendererProfile.to_dict()
        • cleep.libs.internals.sun module
        • cleep.libs.internals.task module
        • cleep.libs.internals.taskfactory module
        • cleep.libs.internals.tools module
          • cidr_to_netmask()
          • compare_compat_string()
          • compare_versions()
          • dbm_to_percent()
          • file_to_base64()
          • full_split_path()
          • hr_bytes()
          • hr_uptime()
          • install_trace_logging_level()
          • install_unhandled_exception_handler()
          • is_core_lib()
          • netmask_to_cidr()
          • raspberry_pi_infos()
          • wpa_passphrase()
      • cleep.libs.tests package
        • cleep.libs.tests.common module
          • get_log_level()
        • cleep.libs.tests.lib module
        • cleep.libs.tests.mockdatetime module
          • mock_datetime()
        • cleep.libs.tests.session module
    • cleep.profiles package
      • cleep.profiles.alarmprofile module
        • AlarmProfile
          • AlarmProfile.STATUS_SCHEDULED
          • AlarmProfile.STATUS_SNOOZED
          • AlarmProfile.STATUS_STOPPED
          • AlarmProfile.STATUS_TRIGGERED
          • AlarmProfile.STATUS_UNKNOWN
          • AlarmProfile.STATUS_UNSCHEDULED
      • cleep.profiles.alertprofile module
        • AlertProfile
      • cleep.profiles.identifiedmessageprofile module
        • IdentifiedMessageProfile
      • cleep.profiles.messageprofile module
        • MessageProfile
      • cleep.profiles.thermostatprofile module
        • ThermostatProfile
          • ThermostatProfile.MODE_ANTIFROST
          • ThermostatProfile.MODE_COMFORT1
          • ThermostatProfile.MODE_COMFORT2
          • ThermostatProfile.MODE_COMFORT3
          • ThermostatProfile.MODE_ECO
          • ThermostatProfile.MODE_STOP
      • cleep.profiles.timerangedmessageprofile module
        • TimeRangedMessageProfile
    • cleep.resources package
      • cleep.resources.audiocaptureresource module
        • AudioCaptureResource
          • AudioCaptureResource.RESOURCE_NAME
      • cleep.resources.audioplaybackresource module
        • AudioPlaybackResource
          • AudioPlaybackResource.RESOURCE_NAME
    • cleep.bus module
    • cleep.common module
      • CATEGORIES
        • CATEGORIES.ALL
        • CATEGORIES.APPLICATION
        • CATEGORIES.DRIVER
        • CATEGORIES.HOBBY
        • CATEGORIES.HOMEAUTOMATION
        • CATEGORIES.MEDIA
        • CATEGORIES.MOBILE
        • CATEGORIES.SERVICE
      • ExecutionStep
        • ExecutionStep.BOOT
        • ExecutionStep.CONFIG
        • ExecutionStep.INIT
        • ExecutionStep.RUN
        • ExecutionStep.STOP
      • MessageRequest
        • MessageRequest.fill_from_dict()
        • MessageRequest.fill_from_request()
        • MessageRequest.is_broadcast()
        • MessageRequest.is_command()
        • MessageRequest.is_external_event()
        • MessageRequest.to_dict()
      • MessageResponse
        • MessageResponse.fill_from_dict()
        • MessageResponse.fill_from_response()
        • MessageResponse.to_dict()
      • PeerInfos
        • PeerInfos.fill_from_dict()
        • PeerInfos.to_dict()
    • cleep.core module
    • cleep.exception module
      • BusError
      • CommandError
      • CommandInfo
      • InvalidMessage
      • InvalidModule
      • InvalidParameter
      • MissingParameter
      • NoMessageAvailable
      • NoResponse
      • ResourceNotAvailable
      • Unauthorized
    • cleep.inventory module
    • cleep.rpcserver module

Indices and tables

• Index

• Module Index

• Search Page