search

DeviceFarmer / stf

Control and manage Android devices from your browser.
https://devicefarmer.github.io
Other
3.52k stars 497 forks source link

[documentation] Well defined device states #677

Open le91688 opened 1 year ago

le91688 commented 1 year ago

(Please correct me if this exists and im missing it, but i swear i searched thoroughly before asking!)

I think adding some documentation that clearly defines the device states, such as present, ready, using, bookable etc would be very useful.

I'm currently developing a tool that utilizes DeviceFarmer's rest API , and ran into some headache adding logic to determine whether I should attempt to lock a device based on these fields, and realized I cant find solid info on what these states mean and how i should interpret them.

I tried looking through the source code for this info and that didn't lead me to anything too fruitful either.

ChatGPT attempted to guess at them :

present: This typically refers to the physical availability of the device. If a device is marked as 'present', it means that it is currently connected to the system.

ready: This usually signifies that the device is not only present, but also prepared for use. It is switched on, booted up, and has no outstanding issues preventing it from functioning normally.

bookable: This field likely refers to whether the device is currently available to be reserved or 'booked' for use. If a device is marked as 'bookable', it should be ready and available for a user to reserve and use.

using: This probably indicates that the device is currently in use. If a device is 'using', it means that it is currently occupied and cannot be accessed by another user.

Perhaps we could add these to docs somewhere, if they are correct?