Safecor
  • API Reference
    • Safecor Package
      • Api
        • Api.add_message_callback()
        • Api.add_ready_callback()
        • Api.add_restart_callback()
        • Api.add_shutdown_callback()
        • Api.add_subscription_callback()
        • Api.archive_extensions_handled()
        • Api.clear_sys_usb_queues()
        • Api.copy_file()
        • Api.create_file()
        • Api.critical()
        • Api.debug()
        • Api.delete_file()
        • Api.discover_components()
        • Api.error()
        • Api.get_current_language()
        • Api.get_default_language()
        • Api.get_disks_list()
        • Api.get_file_fingerprint()
        • Api.get_files_list()
        • Api.get_languages_list()
        • Api.get_mqtt_client()
        • Api.info()
        • Api.mount_file()
        • Api.notify_disk_added()
        • Api.notify_disk_removed()
        • Api.notify_gui_ready()
        • Api.ping()
        • Api.publish()
        • Api.publish_components()
        • Api.read_file()
        • Api.request_energy_state()
        • Api.request_system_info()
        • Api.restart_domain()
        • Api.set_current_language()
        • Api.shutdown()
        • Api.start()
        • Api.stop()
        • Api.subscribe()
        • Api.unmount()
        • Api.warn()
      • ApiHelper
        • ApiHelper.get_disk_name()
        • ApiHelper.get_disk_state()
        • ApiHelper.is_disk_connected()
      • BenchmarkId
        • BenchmarkId.FILES
        • BenchmarkId.INPUTS
      • ComponentState
        • ComponentState.ERROR
        • ComponentState.READY
        • ComponentState.STARTING
        • ComponentState.UNKNOWN
      • ComponentsHelper
        • ComponentsHelper.clear()
        • ComponentsHelper.get_by_id()
        • ComponentsHelper.get_components()
        • ComponentsHelper.get_ids()
        • ComponentsHelper.get_ids_by_type()
        • ComponentsHelper.get_state()
        • ComponentsHelper.get_states()
        • ComponentsHelper.get_type()
        • ComponentsHelper.update()
      • Configuration
        • Configuration.default_language
        • Configuration.identifier
        • Configuration.languages
        • Configuration.name
        • Configuration.settings
      • ConfigurationHelper
        • ConfigurationHelper.apply_configuration()
      • ConnectionType
        • ConnectionType.SERIAL_PORT
        • ConnectionType.TCP_DEBUG
        • ConnectionType.UNIX_SOCKET
      • Constants
        • Constants.ARCHIVE_EXTENSIONS_HANDLED
        • Constants.BENCHMARK_INPUTS_ITERATIONS
        • Constants.DOM0_REPOSITORY_PATH
        • Constants.DOMU_INPUT_SOCKET_FILEPATH
        • Constants.DOMU_REPOSITORY_PATH
        • Constants.ENABLE_LOCAL_LOG
        • Constants.FINGERPRINT_METHOD
        • Constants.FRAME_SIZE
        • Constants.GUI_DOMAIN_NAME
        • Constants.IO_BENCHMARK
        • Constants.LOCAL_LOG_FILEPATH
        • Constants.LOG_STRING_FORMAT_DEBUG
        • Constants.LOG_STRING_FORMAT_PRODUCTION
        • Constants.MQTT_LOG_BROKER_SOCKET
        • Constants.MQTT_LOG_SOCKET_FILTER
        • Constants.MQTT_MSG_BROKER_SOCKET
        • Constants.MQTT_MSG_BROKER_SOCKETS
        • Constants.MQTT_MSG_SOCKET_FILTER
        • Constants.PID_FILES_PATH
        • Constants.SAFECOR_DISK_CONTROLLER
        • Constants.SAFECOR_INPUT_CONTROLLER
        • Constants.SAFECOR_SYSTEM_CONTROLLER
        • Constants.SERIAL_PORT_LOG
        • Constants.SERIAL_PORT_MSG
        • Constants.STR_REPOSITORY
        • Constants.SYS_USB_INPUT_SOCKET_FILEPATH
        • Constants.USB_MOUNT_POINT
        • Constants.XEN_SOCKETS_PATH
      • Debugging
        • Debugging.benchmark_messaging()
      • DiskMonitor
        • DiskMonitor.device_event()
        • DiskMonitor.start()
        • DiskMonitor.stop()
      • DiskState
        • DiskState.CONNECTED
        • DiskState.DISCONNECTED
        • DiskState.MOUNTED
        • DiskState.UNKNOWN
        • DiskState.UNMOUNTED
      • Dom0Controller
        • Dom0Controller.__init__()
        • Dom0Controller.start()
      • Domain
        • Domain.cpu_affinity
        • Domain.domain_type
        • Domain.id
        • Domain.memory
        • Domain.name
        • Domain.package
        • Domain.temp_disk_size
        • Domain.vcpu_group
        • Domain.vcpus
      • DomainType
        • DomainType.BUSINESS
        • DomainType.CORE
        • DomainType.UNKNOWN
      • FileHelper
        • FileHelper.calculate_fingerprint()
        • FileHelper.copy_file()
        • FileHelper.copy_file_to_repository()
        • FileHelper.create_file()
        • FileHelper.get_disks_list()
        • FileHelper.get_files_list()
        • FileHelper.get_folder_contents()
        • FileHelper.get_mount_point()
        • FileHelper.is_archive_file()
        • FileHelper.remove_file()
      • InputType
        • InputType.KEYBOARD
        • InputType.MOUSE
        • InputType.TOUCH
        • InputType.UNKNOWN
      • InputsDaemon
        • InputsDaemon.start()
        • InputsDaemon.stop()
      • KeymapFR
        • KeymapFR.KEYMAP
        • KeymapFR.convertit()
      • LibvirtHelper
        • LibvirtHelper.get_cpu_allocation_for_domain()
        • LibvirtHelper.get_cpu_count()
        • LibvirtHelper.get_domains()
        • LibvirtHelper.get_domains_count()
        • LibvirtHelper.reboot_domain()
      • Logger
        • Logger.clear_log()
        • Logger.critical()
        • Logger.debug()
        • Logger.domain_name()
        • Logger.error()
        • Logger.filename()
        • Logger.format_logline()
        • Logger.info()
        • Logger.is_recording()
        • Logger.is_setup()
        • Logger.log_level()
        • Logger.loglevel_from_topic()
        • Logger.loglevel_value()
        • Logger.module_name()
        • Logger.print()
        • Logger.reset()
        • Logger.set_log_level()
        • Logger.setup()
        • Logger.warn()
        • Logger.warning()
      • MockSysUsbController
        • MockSysUsbController.start()
      • Mouse
        • Mouse.button_equals()
        • Mouse.button_pressed()
        • Mouse.buttons
        • Mouse.buttons_equal()
        • Mouse.equals()
        • Mouse.from_data()
        • Mouse.move
        • Mouse.serialize()
        • Mouse.wheel
        • Mouse.wheel_equals()
        • Mouse.wheel_moved()
        • Mouse.x
        • Mouse.y
      • MouseButton
        • MouseButton.LEFT
        • MouseButton.MIDDLE
        • MouseButton.RIGHT
        • MouseButton.UNKNOWN
      • MouseMove
        • MouseMove.ABSOLUTE
        • MouseMove.RELATIVE
      • MouseWheel
        • MouseWheel.DOWN
        • MouseWheel.NO_MOVE
        • MouseWheel.UP
      • MqttClient
        • MqttClient.add_connected_callback()
        • MqttClient.add_message_callback()
        • MqttClient.connected
        • MqttClient.connection_string
        • MqttClient.connection_type
        • MqttClient.del_message_callback()
        • MqttClient.identifier
        • MqttClient.is_starting
        • MqttClient.on_connected
        • MqttClient.on_log
        • MqttClient.on_message
        • MqttClient.on_subscribed
        • MqttClient.publish()
        • MqttClient.reset_message_callbacks()
        • MqttClient.start()
        • MqttClient.stop()
        • MqttClient.subscribe()
        • MqttClient.unsubscribe()
        • MqttClient.unsubscribe_all()
      • MqttFactory
        • MqttFactory.create_mqtt_client_dom0()
        • MqttFactory.create_mqtt_client_domu()
        • MqttFactory.create_mqtt_network_dev()
      • MqttHelper
        • MqttHelper.check_payload()
      • NotificationFactory
        • NotificationFactory.create_notification_deleted_file()
        • NotificationFactory.create_notification_disk_state()
        • NotificationFactory.create_notification_energy_state()
        • NotificationFactory.create_notification_error()
        • NotificationFactory.create_notification_new_file()
        • NotificationFactory.create_notification_setting_changed()
      • RequestFactory
        • RequestFactory.create_request_copy_file()
        • RequestFactory.create_request_create_file()
        • RequestFactory.create_request_delete_file()
        • RequestFactory.create_request_files_list()
        • RequestFactory.create_request_get_file_fingerprint()
        • RequestFactory.create_request_mount_file()
        • RequestFactory.create_request_ping()
        • RequestFactory.create_request_read_file()
        • RequestFactory.create_request_restart_domain()
        • RequestFactory.create_request_save_log()
        • RequestFactory.create_request_set_language()
        • RequestFactory.create_request_set_log_level()
        • RequestFactory.create_request_start_benchmark()
        • RequestFactory.create_request_unmount()
      • ResponseFactory
        • ResponseFactory.create_entry_component_state()
        • ResponseFactory.create_reponse_benchmark_fichiers_demarre()
        • ResponseFactory.create_reponse_benchmark_fichiers_erreur()
        • ResponseFactory.create_reponse_benchmark_fichiers_termine()
        • ResponseFactory.create_reponse_benchmark_inputs()
        • ResponseFactory.create_response_component_state()
        • ResponseFactory.create_response_copy_file()
        • ResponseFactory.create_response_create_file()
        • ResponseFactory.create_response_disks_list()
        • ResponseFactory.create_response_file_fingerprint()
        • ResponseFactory.create_response_get_setting()
        • ResponseFactory.create_response_language_default()
        • ResponseFactory.create_response_languages_list()
        • ResponseFactory.create_response_list_files()
        • ResponseFactory.create_response_ping()
        • ResponseFactory.create_response_restart_domain()
        • ResponseFactory.create_response_set_setting()
        • ResponseFactory.create_response_shutdown()
      • Screen
        • Screen.height
        • Screen.rotation
        • Screen.width
      • SerialMQTTClient
        • SerialMQTTClient.close()
        • SerialMQTTClient.disconnect()
        • SerialMQTTClient.loop_start()
        • SerialMQTTClient.loop_stop()
        • SerialMQTTClient.on_connection_lost
      • Settings
        • Settings.CURRENT_LANGUAGE
        • Settings.DEFAULT_LANGUAGE
      • SingletonMeta
      • SysLogger
        • SysLogger.critical()
        • SysLogger.debug()
        • SysLogger.error()
        • SysLogger.info()
        • SysLogger.warn()
        • SysLogger.warning()
      • SysUsbController
        • SysUsbController.sanitize_filename()
        • SysUsbController.start()
        • SysUsbController.stop()
      • System
        • System.compute_cpus_for_group()
        • System.compute_vcpus_for_group()
        • System.cpu_affinity_to_string()
        • System.debug_activated()
        • System.domain_name()
        • System.get_cpu_allocation()
        • System.get_framebuffer_dimension()
        • System.get_platform_cpu_count()
        • System.get_screen_height()
        • System.get_screen_rotation()
        • System.get_screen_width()
        • System.get_setting()
        • System.get_settings()
        • System.get_splash_bgcolor_from_topology()
        • System.get_system_information()
        • System.get_system_uuid()
        • System.get_topology()
        • System.get_topology_data()
        • System.get_topology_struct()
        • System.monitor_file()
        • System.parse_kernel_command_line_settings()
        • System.parse_range()
        • System.read_topology_file()
        • System.reset_topology()
        • System.set_setting()
      • TaskRunner
        • TaskRunner.run_task()
        • TaskRunner.start()
        • TaskRunner.stop()
      • Topics
        • Topics.BENCHMARK
        • Topics.COPY_FILE
        • Topics.CREATE_FILE
        • Topics.CURRENT_LANGUAGE
        • Topics.DEBUG
        • Topics.DEBUGGING
        • Topics.DEFAULT_LANGUAGE
        • Topics.DELETED_FILE
        • Topics.DELETE_FILE
        • Topics.DISCOVER
        • Topics.DISCOVER_COMPONENTS
        • Topics.DISKS
        • Topics.DISK_STATE
        • Topics.ENERGY
        • Topics.ENERGY_STATE
        • Topics.ERROR
        • Topics.EVENTS
        • Topics.FILE_FINGERPRINT
        • Topics.GUI_READY
        • Topics.INFO
        • Topics.KEEPALIVE
        • Topics.LANGUAGES
        • Topics.LIST_DISKS
        • Topics.LIST_FILES
        • Topics.LIST_LANGUAGES
        • Topics.MISC
        • Topics.MOUNT_FILE
        • Topics.NEW_FILE
        • Topics.PING
        • Topics.READ_FILE
        • Topics.RESTART_DOMAIN
        • Topics.SAVE_LOG
        • Topics.SETTINGS
        • Topics.SETTING_CHANGED
        • Topics.SET_LANGUAGE
        • Topics.SET_LOG_LEVEL
        • Topics.SHUTDOWN
        • Topics.SYSTEM
        • Topics.SYSTEM_INFO
        • Topics.SYS_USB
        • Topics.SYS_USB_CLEAR_QUEUES
        • Topics.UNMOUNT
        • Topics.WARNING
        • Topics.WORKFLOW
      • Topology
        • Topology.__init__()
        • Topology.add_color()
        • Topology.add_domain()
        • Topology.business_domains()
        • Topology.color_as_hex()
        • Topology.color_as_rgba()
        • Topology.colors()
        • Topology.colors_as_hex()
        • Topology.configurations
        • Topology.default_language
        • Topology.domain()
        • Topology.domain_names()
        • Topology.domains
        • Topology.gui
        • Topology.initialized()
        • Topology.is_pci_bus_blacklisted()
        • Topology.languages
        • Topology.pci
        • Topology.product_name
        • Topology.screen
        • Topology.set_initialized()
        • Topology.use_gui
        • Topology.use_usb
        • Topology.uuid
Safecor
  • API Reference
  • View page source

API Reference

This is the python API for developping products based on Safecor.

The API is available when using the safecor-lib package in a Domain.

  • Safecor Package
    • Api
    • ApiHelper
    • BenchmarkId
    • ComponentState
    • ComponentsHelper
    • Configuration
    • ConfigurationHelper
    • ConnectionType
    • Constants
    • Debugging
    • DiskMonitor
    • DiskState
    • Dom0Controller
    • Domain
    • DomainType
    • FileHelper
    • InputType
    • InputsDaemon
    • KeymapFR
    • LibvirtHelper
    • Logger
    • MockSysUsbController
    • Mouse
    • MouseButton
    • MouseMove
    • MouseWheel
    • MqttClient
    • MqttFactory
    • MqttHelper
    • NotificationFactory
    • RequestFactory
    • ResponseFactory
    • Screen
    • SerialMQTTClient
    • Settings
    • SingletonMeta
    • SysLogger
    • SysUsbController
    • System
    • TaskRunner
    • Topics
    • Topology
Previous Next

© Copyright 2025-2026, Tristan Israël.

Built with Sphinx using a theme provided by Read the Docs.