Document PumpInterface.deliverTreatment contract.

This commit is contained in:
Johannes Mockenhaupt 2021-03-31 20:35:37 +02:00
parent 93b1b37021
commit f4a76a1e24
No known key found for this signature in database
GPG key ID: 9E1EA6AF7BBBB0D1

View file

@ -38,6 +38,12 @@ interface PumpInterface {
val reservoirLevel: Double
val batteryLevel: Int // in percent as integer
/**
* Request a bolus to be delivered, carbs to be stored on pump or both.
*
* @param detailedBolusInfo it's the caller's responsibility to ensure the request can be satisfied by the pump,
* e.g. DBI will not contain carbs if the pump can't store carbs.
*/
fun deliverTreatment(detailedBolusInfo: DetailedBolusInfo): PumpEnactResult
fun stopBolusDelivering()
fun setTempBasalAbsolute(absoluteRate: Double, durationInMinutes: Int, profile: Profile, enforceNew: Boolean): PumpEnactResult