Device

---

Object Hierarchy:

Description:

Content:

Properties:

• public uint battery_level { get; set; }
  The device battery level in percent.
• public uint battery_threshold { get; set; }
  The device battery threshold in percent.
• public uint64 flags { get; set; }
  The device flags.
• public string id { get; set; }
  The device ID.
• public Device parent { get; set construct; }
  The device parent.
• public uint percentage { get; set; }
  The current device percentage.
• public uint64 problems { get; set; }
  The problems with the device that the user could fix, e.
• public uint64 request_flags { get; set; }
  The device request flags.
• public uint status { get; set; }
  The current device status.
• public string update_error { get; set; }
  The device update error.
• public uint update_state { get; set; }
  The device update state.
• public string vendor { get; set; }
  The device vendor.
• public string version { get; set; }
  The device version.
• public uint version_format { get; set; }
  The version format of the device.

Static methods:

• public static void array_ensure_parents (GenericArray<Device> devices)
  Sets the parent object on all devices in the array using the parent ID.
• public static GenericArray<unowned Device> array_filter_flags (GenericArray<Device> devices, DeviceFlags include, DeviceFlags exclude) throws Error
  Creates an array of new devices that match using match_flags.
• public static DeviceFlags flag_from_string (string? val)
  Converts a string to an enumerated value.
• public static unowned string flag_to_string (DeviceFlags val)
  Converts an enumerated value to a string.
• public static bool id_is_valid (string device_id)
  Checks the string is a valid non-partial device ID.
• public static DeviceProblem problem_from_string (string? val)
  Converts a string to an enumerated value.
• public static unowned string problem_to_string (DeviceProblem val)
  Converts an enumerated value to a string.

Creation methods:

• public Device ()
  Creates a new device.

Methods:

• public void add_checksum (string checksum)
  Adds a device checksum.
• public void add_child (Device child)
  Adds a child device.
• public void add_flag (DeviceFlags flag)
  Adds a specific device flag to the device.
• public void add_guid (string guid)
  Adds the GUID if it does not already exist.
• public void add_icon (string icon)
  Adds the icon name if it does not already exist.
• public void add_instance_id (string instance_id)
  Adds the instance ID if it does not already exist.
• public void add_issue (string issue)
  Adds an current issue to this device.
• public void add_problem (DeviceProblem problem)
  Adds a specific device problem kind to the device.
• public void add_protocol (string protocol)
  Adds a device protocol name.
• public void add_release (Release release)
  Adds a release for this device.
• public void add_request_flag (RequestFlags request_flag)
  Adds a specific device request flag to the device.
• public void add_vendor_id (string vendor_id)
  Adds a device vendor ID.
• public int compare (Device self2)
  Comparison function for comparing two device objects.
• public uint32 get_battery_level ()
  Returns the battery level.
• public uint32 get_battery_threshold ()
  Returns the battery threshold under which a firmware update cannot be performed.
• public unowned string get_branch ()
  Gets the current device branch.
• public unowned GenericArray<string> get_checksums ()
  Gets the device checksums.
• public unowned GenericArray<Device> get_children ()
  Gets the device children.
• public unowned string? get_composite_id ()
  Gets the composite ID, falling back to the device ID if unset.
• public uint64 get_created ()
  Gets when the device was created.
• public unowned string get_details_url ()
  Gets the device URL.
• public uint64 get_flags ()
  Gets device flags.
• public uint32 get_flashes_left ()
  Gets the number of flash cycles left on the device
• public unowned string get_guid_default ()
  Gets the default GUID.
• public unowned GenericArray<string> get_guids ()
  Gets the GUIDs.
• public unowned GenericArray<string> get_icons ()
  Gets the icon names to use for the device.
• public unowned string get_id ()
  Gets the ID.
• public string get_id_display ()
  Gets the device ID suffixed with the display name if set.
• public uint32 get_install_duration ()
  Gets the time estimate for firmware installation (in seconds)
• public unowned GenericArray<string> get_instance_ids ()
  Gets the instance IDs.
• public unowned GenericArray<string> get_issues ()
  Gets the list of issues currently affecting this device.
• public uint64 get_modified ()
  Gets when the device was modified.
• public unowned string get_name ()
  Gets the device name.
• public unowned Device get_parent ()
  Gets the parent.
• public unowned string get_parent_id ()
  Gets the parent ID.
• public uint get_percentage ()
  Returns the percentage completion of the device.
• public unowned string get_plugin ()
  Gets the plugin that created the device.
• public uint64 get_problems ()
  Gets device problems.
• public unowned GenericArray<string> get_protocols ()
  Gets the device protocol names.
• public unowned Release get_release_default ()
  Gets the default release for this device.
• public unowned GenericArray<Release> get_releases ()
  Gets all the releases for this device.
• public uint64 get_request_flags ()
  Gets device request flags.
• public unowned Device get_root ()
  Gets the device root.
• public unowned string get_serial ()
  Gets the serial number for the device.
• public Status get_status ()
  Returns what the device is currently doing.
• public unowned string get_summary ()
  Gets the device summary.
• public unowned string get_update_error ()
  Gets the update error string.
• public UpdateState get_update_state ()
  Gets the update state.
• public unowned string get_vendor ()
  Gets the device vendor.
• public unowned GenericArray<string> get_vendor_ids ()
  Gets the device vendor ID.
• public unowned string get_version ()
  Gets the device version.
• public unowned string get_version_bootloader ()
  Gets the version of the bootloader.
• public uint64 get_version_bootloader_raw ()
  Gets the bootloader version of firmware the device will accept in raw format.
• public uint64 get_version_build_date ()
  Gets the date when the firmware was built.
• public VersionFormat get_version_format ()
  Gets the version format.
• public unowned string get_version_highest ()
  Gets the highest version of firmware the device will accept.
• public uint64 get_version_highest_raw ()
  Gets the highest version of firmware the device will accept in raw format.
• public unowned string get_version_lowest ()
  Gets the lowest version of firmware the device will accept.
• public uint64 get_version_lowest_raw ()
  Gets the lowest version of firmware the device will accept in raw format.
• public uint64 get_version_raw ()
  Gets the raw version number from the hardware before converted to a string.
• public bool has_checksum (string checksum)
  Finds out if the device has this specific checksum.
• public bool has_flag (DeviceFlags flag)
  Finds if the device has a specific device flag.
• public bool has_guid (string guid)
  Finds out if the device has this specific GUID.
• public bool has_icon (string icon)
  Finds out if the device has this specific icon.
• public bool has_instance_id (string instance_id)
  Finds out if the device has this specific instance ID.
• public bool has_problem (DeviceProblem problem)
  Finds if the device has a specific device problem kind.
• public bool has_protocol (string protocol)
  Finds out if the device has this specific protocol name.
• public bool has_request_flag (RequestFlags request_flag)
  Finds if the device has a specific device request flag.
• public bool has_vendor_id (string vendor_id)
  Finds out if the device has this specific vendor ID.
• public void incorporate (Device donor)
  Copy all properties from the donor object if they have not already been set.
• public bool match_flags (DeviceFlags include, DeviceFlags exclude)
  Check if the device flags match.
• public void remove_child (Device child)
  Removes a child device.
• public void remove_children ()
  Removes all child devices.
• public void remove_flag (DeviceFlags flag)
  Removes a specific device flag from the device.
• public void remove_problem (DeviceProblem problem)
  Removes a specific device problem kind from the device.
• public void remove_request_flag (RequestFlags request_flag)
  Removes a specific device request flag from the device.
• public void set_battery_level (uint32 battery_level)
  Sets the battery level, or fwupd_battery_level_invalid.
• public void set_battery_threshold (uint32 battery_threshold)
  Sets the battery level, or fwupd_battery_level_invalid for the default.
• public void set_branch (string? branch)
  Sets the current device branch.
• public void set_composite_id (string? composite_id)
  Sets the composite ID, which is usually a SHA1 hash of a grandparent or parent device.
• public void set_created (uint64 created)
  Sets when the device was created.
• public void set_details_url (string? details_url)
  Sets the device URL.
• public void set_flags (uint64 flags)
  Sets device flags.
• public void set_flashes_left (uint32 flashes_left)
  Sets the number of flash cycles left on the device
• public void set_id (string? id)
  Sets the ID.
• public void set_install_duration (uint32 duration)
  Sets the time estimate for firmware installation (in seconds)
• public void set_modified (uint64 modified)
  Sets when the device was modified.
• public void set_name (string? name)
  Sets the device name.
• public void set_parent (Device? parent)
  Sets the parent.
• public void set_parent_id (string? parent_id)
  Sets the parent ID.
• public void set_percentage (uint percentage)
  Sets the percentage completion of the device.
• public void set_plugin (string? plugin)
  Sets the plugin that created the device.
• public void set_problems (uint64 problems)
  Sets device problems.
• public void set_request_flags (uint64 request_flags)
  Sets device request flags.
• public void set_serial (string? serial)
  Sets the serial number for the device.
• public void set_status (Status status)
  Sets what the device is currently doing.
• public void set_summary (string? summary)
  Sets the device summary.
• public void set_update_error (string? update_error)
  Sets the update error string.
• public void set_update_state (UpdateState update_state)
  Sets the update state.
• public void set_vendor (string? vendor)
  Sets the device vendor.
• public void set_version (string? version)
  Sets the device version.
• public void set_version_bootloader (string? version_bootloader)
  Sets the bootloader version.
• public void set_version_bootloader_raw (uint64 version_bootloader_raw)
  Sets the raw bootloader version number from the hardware before converted to a string.
• public void set_version_build_date (uint64 version_build_date)
  Sets the date when the firmware was built.
• public void set_version_format (VersionFormat version_format)
  Sets the version format.
• public void set_version_highest (string? version_highest)
  Sets the highest version of firmware the device will accept.
• public void set_version_highest_raw (uint64 version_highest_raw)
  Sets the raw highest version number from the hardware before being converted to a string.
• public void set_version_lowest (string? version_lowest)
  Sets the lowest version of firmware the device will accept.
• public void set_version_lowest_raw (uint64 version_lowest_raw)
  Sets the raw lowest version number from the hardware before converted to a string.
• public void set_version_raw (uint64 version_raw)
  Sets the raw version number from the hardware before converted to a string.

Inherited Members: