PeripheralsData.md

PeripheralsData

Peripheral readings and settings. Responses include only fields reported by the compute node; no field is guaranteed to be present. An absent field does not imply a zero or false value. All fields are optional to support partial updates. Writes require the corresponding feature to be enabled; settings for disabled features are ignored: - deviceMotion: acceleration, gyroscope, magnetic, orientation. - deviceEnvironmentControl: temperature, proximity, light, pressure, humidity. - deviceLocation: gpsLat, gpsLon, gpsAlt, gpsToffs. - deviceBattery: acOnline, batteryPresent, batteryStatus, batteryHealth, batteryCapacity. - biometricBypass: biometricPass. These write restrictions do not determine which fields are returned by GET.

Properties

Name	Type	Description	Notes
acceleration	List[float]	Accelerometer reading as [x, y, z].	[optional]
gyroscope	List[float]	Gyroscope reading as [x, y, z].	[optional]
magnetic	List[float]	Magnetometer reading as [x, y, z].	[optional]
orientation	List[float]	Device orientation vector.	[optional]
temperature	float	Ambient temperature reading.	[optional]
proximity	float	Proximity sensor reading.	[optional]
light	float	Ambient light sensor reading.	[optional]
pressure	float	Barometric pressure reading.	[optional]
humidity	float	Relative humidity reading.	[optional]
gps_lat	float	GPS latitude in decimal degrees.	[optional]
gps_lon	float	GPS longitude in decimal degrees.	[optional]
gps_alt	float	GPS altitude in meters.	[optional]
gps_toffs	float	GPS time offset in seconds.	[optional]
ac_online	float	AC power connection: 0 = disconnected, 1 = connected.	[optional]
battery_present	float	Battery presence: 0 = absent, 1 = present.	[optional]
battery_status	str	Battery charging status.	[optional]
battery_health	str	Battery health.	[optional]
battery_capacity	float	Battery charge level as a percentage.	[optional]
biometric_pass	float	Biometric bypass: 0 = disabled, 1 = enabled.	[optional]

Example

from corellium.models.peripherals_data import PeripheralsData

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

# convert the object into a dict
peripherals_data_dict = peripherals_data_instance.to_dict()
# create an instance of PeripheralsData from a dict
peripherals_data_from_dict = PeripheralsData.from_dict(peripherals_data_dict)

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