Skip to content

Model.md

Latest commit

 

History

History
69 lines (60 loc) · 4.47 KB

Model.md

File metadata and controls

69 lines (60 loc) · 4.47 KB
Raw

Model

Properties

Name Type Description Notes
type str Device type, e.g. iOS, Android or IoT.
flavor str The model's identifier, for example "iphone17a". Pass this value as `flavor` when you create an instance, and as `{model}` when you list its software.
description str Human-readable model name, e.g. "iPhone Air".
model str Marketing model identifier, e.g. "iPhone18,4".
hardware_model str Hardware board model, e.g. "d23ap".
board_config str Board configuration identifier.
platform str Device platform.
cpid float Chip ID.
bdid float Board ID.
vendor str Vendor gating this model, when it is vendor-restricted.
hidden bool Whether this model is hidden from device pickers.
is_beta bool Whether this model is a beta device.
peripherals bool Whether the device supports peripherals.
has_software bool Whether any software build is available for this model.
supports_rapid_start bool Whether at least one software build for this model can start from a snapshot.
default_firmware str Filename pattern that selects the default build. It ignores case. Null if the model has no default.
cores float Number of CPU cores a new instance of this model gets if you do not choose one.
cores_min float Fewest CPU cores you can give an instance of this model.
cores_max float Most CPU cores you can give an instance of this model.
cores_step float If present, core counts must go up in steps of this size between `coresMin` and `coresMax`. [optional]
cores_allowed List[float] If present, the exact core counts you may choose, smallest first. When set, use one of these values. [optional]
ram float Memory, in MiB (1024 = 1 GiB), that a new instance gets if you do not choose an amount.
ram_min float Smallest memory amount, in MiB, you can give an instance of this model.
ram_max float Largest memory amount, in MiB, you can give an instance of this model.
dynamic_hardware_changes bool Whether cores and memory can be changed while the instance is running.
partitions List[ModelPartition] Storage partitions of this model.
frame ModelFrame
product_image ModelProductImage
has_frame_variant bool Whether this model is the bezel-framed variant of its device type.
show_options List[str] Preset boot options this model offers.
string_udid bool Whether this model takes its UDID as a free-form string.
charm_boot_args List[Dict[str, Optional[object]]] Model-specific boot argument field definitions. [optional]
requires_preset_boot_options bool Whether a preset boot option must be chosen when creating an instance.
supports_preset_boot_options bool Whether preset boot options are supported.
supports_custom_firmware bool Whether custom firmware is supported.
supports_custom_firmware_image bool Whether a user-supplied firmware image can be uploaded for this model.
supports_custom_kernel bool Whether a custom kernel is supported.
supports_custom_devicetree bool Whether a custom device tree is supported.
supports_custom_mmio bool Whether custom MMIO configuration is supported.
supports_fvp bool Whether this model is an Arm Fixed Virtual Platform.
mast bool Whether MATRIX security assessments can run on instances of this model.

Example

from corellium.models.model import Model

# TODO update the JSON string below
json = "{}"
# create an instance of Model from a JSON string
model_instance = Model.from_json(json)
# print the JSON string representation of the object
print(Model.to_json())

# convert the object into a dict
model_dict = model_instance.to_dict()
# create an instance of Model from a dict
model_from_dict = Model.from_dict(model_dict)

[Back to Model list] [Back to API list] [Back to README]