Index: dialin/squish/denaliMessages.py =================================================================== diff -u -r2844f230ef5c84799b7577e1a2090c0a47a78d51 -rc12fe403b6fd5df2f6c2a25024c35bbcd7a92b84 --- dialin/squish/denaliMessages.py (.../denaliMessages.py) (revision 2844f230ef5c84799b7577e1a2090c0a47a78d51) +++ dialin/squish/denaliMessages.py (.../denaliMessages.py) (revision c12fe403b6fd5df2f6c2a25024c35bbcd7a92b84) @@ -194,16 +194,17 @@ ## ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ def buildSetTreatmentParamRanges(vMinTreatmentDuration, vMaxTreatmentDuration, vMinUFVolume, vMaxUFVolume, vMinDialysateFlowRate, vMaxDialysateFlowRate): """ + the Treatment adjustment param ranges data message builder method | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(U32) | #2:(U32) | #3:(F32) | #4:(F32) | #5:(U32) | #6:(U32) | |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: |:--: |:--: |:--: |:--: |:--: | |0x1A00| 0x020 | 6 | 1/60 Hz| Y | HD | UI | Treatment adjustment param ranges Data | \ref Data::mDuration_Min | \ref Data::mDuration_Max | \ref Data::mUltrafiltration_Volume_Min | \ref Data::mUltrafiltration_Volume_Max | \ref Data::mDialysate_Flow_Min | \ref Data::mDialysate_Flow_Max | - :param vMinTreatmentDuration: - :param vMaxTreatmentDuration: - :param vMinUFVolume: - :param vMaxUFVolume: - :param vMinDialysateFlowRate: - :param vMaxDialysateFlowRate: - :return: + :param vMinTreatmentDuration: Min Treatment Duration + :param vMaxTreatmentDuration: Max Treatment Duration + :param vMinUFVolume: Min UF Volume + :param vMaxUFVolume: Max UF Volume + :param vMinDialysateFlowRate: Min Dialysate Flow Rate + :param vMaxDialysateFlowRate: Max Dialysate Flow Rate + :return: built message frame(s) """ msg = messageBuilder.buildMessage(GuiActionType.TreatmentRanges, 4 * 6, True, utils.toI32(vMinTreatmentDuration), @@ -219,13 +220,13 @@ def setTreatmentParamRanges(vMinTreatmentDuration, vMaxTreatmentDuration, vMinUFVolume, vMaxUFVolume, vMinDialysateFlowRate, vMaxDialysateFlowRate): """ the Treatment adjustment param ranges data message setter/sender method - :param vMinTreatmentDuration: - :param vMaxTreatmentDuration: - :param vMinUFVolume: - :param vMaxUFVolume: - :param vMinDialysateFlowRate: - :param vMaxDialysateFlowRate: - :return: + :param vMinTreatmentDuration: Min Treatment Duration + :param vMaxTreatmentDuration: Max Treatment Duration + :param vMinUFVolume: Min UF Volume + :param vMaxUFVolume: Max UF Volume + :param vMinDialysateFlowRate: Min Dialysate Flow Rate + :param vMaxDialysateFlowRate: Max Dialysate Flow Rate + :return: N/A """ frames = buildSetTreatmentParamRanges(vMinTreatmentDuration, vMaxTreatmentDuration, vMinUFVolume, vMaxUFVolume, vMinDialysateFlowRate, vMaxDialysateFlowRate) frames = messageBuilder.toCandumpFormat(frames) @@ -236,17 +237,18 @@ def buildSetTreatmentBloodFlowRate(vFlowSetPt, vMeasFlow, vRotSpd, vMotSpd, vMCSpd, vMCCurr, vPWM): """ + the Blood Flow Data message builder method | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(S32) | #2:(F32) | #3:(F32) | #4:(F32) | #5:(F32) | #6:(F32) | #7:(F32) | |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: |:--: |:--: |:--: |:--: |:--: |:--: | |0x0500| 0x040 | 7 | 1 Hz | N | HD | All | Blood Flow Data | \ref Data::mFlowSetPoint | \ref Data::mMeasuredFlow | \ref Data::mRotorSpeed | \ref Data::mMotorSpeed | \ref Data::mMotorCtlSpeed | \ref Data::mMotorCtlCurrent | \ref Data::mPWMDutyCycle | - :param vFlowSetPt: - :param vMeasFlow: - :param vRotSpd: - :param vMotSpd: - :param vMCSpd: - :param vMCCurr: - :param vPWM: - :return: + :param vFlowSetPt: Flow Set Point + :param vMeasFlow: Measured Flow + :param vRotSpd: Rot Speed + :param vMotSpd: Motor Speed + :param vMCSpd: MC Speed + :param vMCCurr: MC Current + :param vPWM: PWM + :return: built message frame(s) """ msg = messageBuilder.buildMessage(GuiActionType.BloodFlow, 4 * 7, False, utils.toI32(vFlowSetPt ), @@ -263,14 +265,14 @@ def setTreatmentBloodFlowRate(vFlowSetPt, vMeasFlow, vRotSpd, vMotSpd, vMCSpd, vMCCurr, vPWM): """ the Blood Flow Data message setter/sender method - :param vFlowSetPt: - :param vMeasFlow: - :param vRotSpd: - :param vMotSpd: - :param vMCSpd: - :param vMCCurr: - :param vPWM: - :return: + :param vFlowSetPt: Flow Set Point + :param vMeasFlow: Measured Flow + :param vRotSpd: Rot Speed + :param vMotSpd: Motor Speed + :param vMCSpd: MC Speed + :param vMCCurr: MC Current + :param vPWM: PWM + :return: N/A """ frames = buildSetTreatmentBloodFlowRate(vFlowSetPt, vMeasFlow, vRotSpd, vMotSpd, vMCSpd, vMCCurr, vPWM) frames = messageBuilder.toCandumpFormat(frames) @@ -281,17 +283,18 @@ def buildSetTreatmentDialysateFlowRate(vFlowSetPt, vMeasFlow, vRotSpd, vMotSpd, vMCSpd, vMCCurr, vPWM): """ + the Dialysate Flow Data message builder method | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(S32) | #2:(F32) | #3:(F32) | #4:(F32) | #5:(F32) | #6:(F32) | #7:(F32) | |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: |:--: |:--: |:--: |:--: |:--: |:--: | |0x0800| 0x040 | 7 | 1 Hz | N | HD | All | Dialysate Flow Data | mFlowSetPoint | mMeasuredFlow | mRotorSpeed | mMotorSpeed | mMotorCtlSpeed | mMotorCtlCurrent | mPWMDutyCycle | - :param vFlowSetPt: - :param vMeasFlow: - :param vRotSpd: - :param vMotSpd: - :param vMCSpd: - :param vMCCurr: - :param vPWM: - :return: + :param vFlowSetPt: Flow Set Point + :param vMeasFlow: Measured Flow + :param vRotSpd: Rot Speed + :param vMotSpd: Motor Speed + :param vMCSpd: MC Speed + :param vMCCurr: MC Current + :param vPWM: PWM + :return: built message frame(s) """ msg = messageBuilder.buildMessage(GuiActionType.DialysateInletFlow, 4 * 7, False, utils.toI32(vFlowSetPt), @@ -308,14 +311,14 @@ def setTreatmentDialysateFlowRate(vFlowSetPt, vMeasFlow, vRotSpd, vMotSpd, vMCSpd, vMCCurr, vPWM): """ the Dialysate Flow Data message setter/sender method - :param vFlowSetPt: - :param vMeasFlow: - :param vRotSpd: - :param vMotSpd: - :param vMCSpd: - :param vMCCurr: - :param vPWM: - :return: + :param vFlowSetPt: Flow Set Point + :param vMeasFlow: Measured Flow + :param vRotSpd: Rot Speed + :param vMotSpd: Motor Speed + :param vMCSpd: MC Speed + :param vMCCurr: MC Current + :param vPWM: PWM + :return: N/A """ frames = buildSetTreatmentDialysateFlowRate(vFlowSetPt, vMeasFlow, vRotSpd, vMotSpd, vMCSpd, vMCCurr, vPWM) frames = messageBuilder.toCandumpFormat(frames) @@ -326,14 +329,15 @@ def buildTreatmentAdjustBloodDialysateResponse(vAccepted, vReason, vBloodRate, vDialysate): """ + the Blood/dialysate rate change Response message builder method | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(U32) | #2:(U32) | #3:(U32) | #4:(U32) | |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: |:--: |:--: |:--: | |0x1800| 0x020 | 6 | Rsp | Y | HD | UI | Blood/dialysate rate change Response | \ref Data::mAccepted | \ref Data::mReason | \ref Data::mBloodRate | \ref Data::mDialysateRate | - :param vAccepted: - :param vReason: - :param vBloodRate: - :param vDialysate: - :return: + :param vAccepted: boolean accept/reject response + :param vReason: rejection reason + :param vBloodRate: Blood Flow Rate + :param vDialysate: Dialysate Flow Rate + :return: built message frame(s) """ msg = messageBuilder.buildMessage(GuiActionType.AdjustBloodDialysateRsp, 4 * 4, True, utils.toI32(vAccepted), @@ -347,11 +351,11 @@ def sendTreatmentAdjustBloodDialysateResponse(vAccepted, vReason, vBloodRate, vDialysate): """ the Blood/dialysate rate change Response message setter/sender method - :param vAccepted: - :param vReason: - :param vBloodRate: - :param vDialysate: - :return: + :param vAccepted: boolean accept/reject response + :param vReason: rejection reason + :param vBloodRate: Blood Flow Rate + :param vDialysate: Dialysate Flow Rate + :return: N/A """ frames = buildTreatmentAdjustBloodDialysateResponse(vAccepted, vReason, vBloodRate, vDialysate) frames = messageBuilder.toCandumpFormat(frames) @@ -362,14 +366,15 @@ def buildTreatmentAdjustDurationResponse(vAccepted, vReason, vDuration, vUltrafiltration): """ + the Treatment Duration change Response message builder method | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(U32) | #2:(U32) | #3:(U32) | #5:(F32) | |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: |:--: |:--: |:--: | |0x1B00| 0x020 | 6 | Rsp | Y | HD | UI | Treatment Duration change Response | \ref Data::mAccepted | \ref Data::mReason | \ref Data::mDuration | \ref Data::mUFVolume | - :param vAccepted: - :param vReason: - :param vDuration: - :param vUltrafiltration: - :return: + :param vAccepted: boolean accept/reject response + :param vReason: rejection reason + :param vDuration: Treatment Duration + :param vUltrafiltration: Ultrafiltration Volume + :return: built message frame(s) """ msg = messageBuilder.buildMessage(GuiActionType.AdjustDurationRsp, 4 * 4, True, utils.toI32(vAccepted), @@ -383,11 +388,11 @@ def sendTreatmentAdjustDurationResponse(vAccepted, vReason, vDuration, vUltrafiltration): """ the Treatment Duration change Response message setter/sender method - :param vAccepted: - :param vReason: - :param vDuration: - :param vUltrafiltration: - :return: + :param vAccepted: boolean accept/reject response + :param vReason: rejection reason + :param vDuration: Treatment Duration + :param vUltrafiltration: Ultrafiltration Volume + :return: N/A """ frames = buildTreatmentAdjustDurationResponse(vAccepted, vReason, vDuration, vUltrafiltration) frames = messageBuilder.toCandumpFormat(frames) @@ -398,11 +403,12 @@ def buildTreatmentAdjustUltrafiltrationStateResponse(vState): """ + the Treatment ultrafiltration adjustment response message builder method | MSG | CAN ID | M.Box | Type | Ack | Src | Dest | Description | #1:(U08) | |:----:|:------:|:-----:|:----:|:---:|:---:|:----:|:-----------: |:--: | |0x1000| 0x100 | 9 | Rsp | N | HD | UI | Generic response ACK/NAK | mAccepted | - :param vState: - :return: + :param vState: Ultrafiltionation State + :return: built message frame(s) """ msg = messageBuilder.buildMessage(GuiActionType.AdjustUltrafiltrationStateReq, 1 * 4 , False, utils.toI32(vState) @@ -414,8 +420,8 @@ """ the Treatment ultrafiltration adjustment response message setter/sender method this is actually the Generic response ACK/NAK message - :param vState: - :return: + :param vState: Ultrafiltionation State + :return: N/A """ frames = buildTreatmentAdjustUltrafiltrationStateResponse(vState) frames = messageBuilder.toCandumpFormat(frames) @@ -427,33 +433,34 @@ def setTreatmentAdjustUltrafiltrationAccepted(): """ a convenient method for setTreatmentAdjustUltrafiltrationStateResponse which sends accept true - :return: + :return: N/A """ setTreatmentAdjustUltrafiltrationStateResponse( EResponse.Accepted ) def setTreatmentAdjustUltrafiltrationRejected(): """ a convenient method for setTreatmentAdjustUltrafiltrationStateResponse which sends accept false - :return: + :return: N/A """ setTreatmentAdjustUltrafiltrationStateResponse( EResponse.Rejected ) def buildTreatmentAdjustUltrafiltrationEditResponse(vAccepted, vReason, vVolume, vDuration, vDurationDiff, vRate, vRateDiff, vRateOld): """ + the ultrafiltration volume change response message builder method | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(U32) | #2:(U32) | #1:(U32) | #2:(U32) | #3:(F32) | #4:(U32) | #5:(F32) | #6:(U32) | #7:(U32) | #8:(F32) | |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: |:--: |:--: |:--: |:--: |:--: |:--: |:--: |:--: |:--: | |0x1300| 0x020 | 6 | Rsp | Y | HD | UI | UF Vol. Change Response | \ref Data::mAccepted | \ref Data::mReason | \ref Data::mAccepted | \ref Data::mReason | \ref Data::mVolume | \ref Data::mDuration | \ref Data::mRate | \ref Data::mDurationDiff | \ref Data::mRateDiff | \ref Data::mRateOld | - :param vAccepted: - :param vReason: - :param vVolume: - :param vDuration: - :param vDurationDiff: - :param vRate: - :param vRateDiff: - :param vRateOld: - :return: + :param vAccepted: boolean accept/reject response + :param vReason: rejection reason + :param vVolume: Ultrafiltration Volume + :param vDuration: Treatment Duration + :param vDurationDiff: Duration Difference + :param vRate: Ultrafiltraion Rate + :param vRateDiff: Ultrafiltraion Rate Difference + :param vRateOld: Ultrafiltraion Rate Old + :return: built message frame(s) """ msg = messageBuilder.buildMessage(GuiActionType.AdjustUltrafiltrationEditRsp, 8 * 4 , True, utils.toI32(vAccepted), @@ -471,15 +478,15 @@ def setTreatmentAdjustUltrafiltrationEditResponse(vAccepted, vReason, vVolume, vDuration, vDurationDiff, vRate, vRateDiff, vRateOld): """ the ultrafiltration volume change response message setter/sender method - :param vAccepted: - :param vReason: - :param vVolume: - :param vDuration: - :param vDurationDiff: - :param vRate: - :param vRateDiff: - :param vRateOld: - :return: + :param vAccepted: boolean accept/reject response + :param vReason: rejection reason + :param vVolume: Ultrafiltration Volume + :param vDuration: Treatment Duration + :param vDurationDiff: Duration Difference + :param vRate: Ultrafiltraion Rate + :param vRateDiff: Ultrafiltraion Rate Difference + :param vRateOld: Ultrafiltraion Rate Old + :return: N/A """ frames = buildTreatmentAdjustUltrafiltrationEditResponse(vAccepted, vReason, vVolume, vDuration, vDurationDiff, vRate, vRateDiff, vRateOld) frames = messageBuilder.toCandumpFormat(frames) @@ -492,8 +499,8 @@ """ a convenient method for setTreatmentAdjustUltrafiltrationEditResponse which only sends a rejection reason and sends other values all as zero - :param vReason: - :return: + :param vReason: rejection reason + :return: N/A """ frames = buildTreatmentAdjustUltrafiltrationEditResponse(0, vReason, 0, 0, 0, 0, 0, 0) frames = messageBuilder.toCandumpFormat(frames) @@ -504,15 +511,16 @@ def buildTreatmentAdjustUltrafiltrationConfirmResponse(vAccepted, vReason, vVolume, vDuration, vRate): """ + the ultrafiltratin volume Change Confirmation Response message builder method | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(U32) | #2:(U32) | #3:(F32) | #4:(U32) | #5:(F32) | |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: |:--: |:--: |:--: |:--: | |0x2E00| 0x020 | 6 | Rsp | Y | HD | UI | UF Vol. Change Confirmation Response | \ref Data::mAccepted | \ref Data::mReason | \ref Data::mVolume | \ref Data::mDuration | \ref Data::mRate | - :param vAccepted: - :param vReason: - :param vVolume: - :param vDuration: - :param vRate: - :return: + :param vAccepted: boolean accept/reject response + :param vReason: rejection reason + :param vVolume: Ultrafiltration Volume + :param vDuration: Treatment Duration + :param vRate: Ultrafiltration Rate + :return: built message frame(s) """ msg = messageBuilder.buildMessage(GuiActionType.AdjustUltrafiltrationConfirmRsp, 5 * 4 , True, utils.toI32(vAccepted), @@ -527,12 +535,12 @@ def setTreatmentAdjustUltrafiltrationConfirmResponse (vAccepted, vReason, vVolume, vDuration, vRate): """ the ultrafiltratin volume Change Confirmation Response message setter/sender method - :param vAccepted: - :param vReason: - :param vVolume: - :param vDuration: - :param vRate: - :return: + :param vAccepted: boolean accept/reject response + :param vReason: rejection reason + :param vVolume: Ultrafiltration Volume + :param vDuration: Treatment Duration + :param vRate: Ultrafiltration Rate + :return: N/A """ frames = buildTreatmentAdjustUltrafiltrationConfirmResponse(vAccepted, vReason, vVolume, vDuration, vRate) frames = messageBuilder.toCandumpFormat(frames) @@ -546,8 +554,8 @@ a convenient method for setTreatmentAdjustUltrafiltrationConfirmResponse which only sends a rejection reason and sends other values all as zero - :param vReason: - :return: + :param vReason: rejection reason + :return: N/A """ frames = buildTreatmentAdjustUltrafiltrationConfirmResponse(0, vReason, 0, 0, 0) frames = messageBuilder.toCandumpFormat(frames) @@ -558,13 +566,14 @@ def buildTreatmentTime(vSecsTotal, vSecsElap, vSecsRem): """ + the Treatment Time Data message builder method | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(U32) | #2:(U32) | #3:(U32) | |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: |:--: |:--: | |0x0D00| 0x040 | 7 | 1 Hz | N | HD | All | Treatment Time Data | \ref Data::mTotal | \ref Data::mElapsed | \ref Data::mRemaining | - :param vSecsTotal: - :param vSecsElap: - :param vSecsRem: - :return: + :param vSecsTotal: Treatment Total Duration in Seconds + :param vSecsElap: Treatment Total Elapsed Time in Seconds + :param vSecsRem: Treatment Remaining Time in Seconds + :return: built message frame(s) """ msg = messageBuilder.buildMessage(GuiActionType.TreatmentTime, 3 * 4, False, utils.toI32(vSecsTotal), @@ -577,10 +586,10 @@ def setTreatmentTime(vSecsTotal, vSecsElap, vSecsRem = None): """ the Treatment Time Data message setter/sender method - :param vSecsTotal: - :param vSecsElap: - :param vSecsRem: - :return: + :param vSecsTotal: Treatment Total Duration in Seconds + :param vSecsElap: Treatment Total Elapsed Time in Seconds + :param vSecsRem: Treatment Remaining Time in Seconds + :return: N/A """ if vSecsRem == None: vSecsRem = vSecsTotal - vSecsElap @@ -593,17 +602,18 @@ def buildSetTreatmentUltrafiltration(vRefUFVol, vMeasUFVol, vRotSpd, vMotSpd, vMCSpd, vMCCurr, vPWM): """ + the Outlet Flow Data message builder method | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(F32) | #2:(F32) | #3:(F32) | #4:(F32) | #5:(F32) | #6:(F32) | #7:(F32) | |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: |:--: |:--: |:--: |:--: |:--: |:--: | |0x0B00| 0x040 | 7 | 1 Hz | N | HD | All | Outlet Flow Data | \ref Data::mRefUFVol | \ref Data::mMeasUFVol | \ref Data::mRotorSpeed | \ref Data::mMotorSpeed | \ref Data::mMotorCtlSpeed | \ref Data::mMotorCtlCurrent | \ref Data::mPWMDtCycle | - :param vRefUFVol: - :param vMeasUFVol: - :param vRotSpd: - :param vMotSpd: - :param vMCSpd: - :param vMCCurr: - :param vPWM: - :return: + :param vRefUFVol: Ref UF Volume + :param vMeasUFVol: Measured UF Volume + :param vRotSpd: Rot Speed + :param vMotSpd: Motor Speed + :param vMCSpd: MC Speed + :param vMCCurr: MC Current + :param vPWM: PWM + :return: built message frame(s) """ msg = messageBuilder.buildMessage(GuiActionType.DialysateOutletFlow, 4 * 7, False, utils.toF32(vRefUFVol), @@ -620,14 +630,14 @@ def setTreatmentUltrafiltration(vRefUFVol, vMeasUFVol, vRotSpd, vMotSpd, vMCSpd, vMCCurr, vPWM): """ the Outlet Flow Data message setter/sender method - :param vRefUFVol: - :param vMeasUFVol: - :param vRotSpd: - :param vMotSpd: - :param vMCSpd: - :param vMCCurr: - :param vPWM: - :return: + :param vRefUFVol: Ref UF Volume + :param vMeasUFVol: Measured UF Volume + :param vRotSpd: Rot Speed + :param vMotSpd: Motor Speed + :param vMCSpd: MC Speed + :param vMCCurr: MC Current + :param vPWM: PWM + :return: N/A """ frames = buildSetTreatmentUltrafiltration(vRefUFVol, vMeasUFVol, vRotSpd, vMotSpd, vMCSpd, vMCCurr, vPWM ) frames = messageBuilder.toCandumpFormat(frames) @@ -640,15 +650,16 @@ ## ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ def buildPressureOcclusionData(vArterialPressure, vVenousPressure, vBloodPumpOcclusion, vDialysateInletPumpOcclusion, vDialysateOutletPumpOcclusion): """ + the Pressure/Occlusion Data messages builder mehtod | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(F32) | #2:(F32) | #3:(F32) | #4:(F32) | #5:(F32) | |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: |:--: |:--: |:--: |:--: | |0x0900| 0x040 | 7 | 1 Hz | N | HD | All | PressureOcclusion Data | \ref Data::mArterialPressure | \ref Data::mVenousPressure | \ref Data::mBloodPumpOcclusion | \ref Data::mDialysateInletPumpOcclusion | \ref Data::mDialysateOutletPumpOcclusion | - :param vArterialPressure: - :param vVenousPressure: - :param vBloodPumpOcclusion: - :param vDialysateInletPumpOcclusion: - :param vDialysateOutletPumpOcclusion: - :return: + :param vArterialPressure: Arterial Pressure + :param vVenousPressure: Venous Pressure + :param vBloodPumpOcclusion: Blood Pump Occlusion + :param vDialysateInletPumpOcclusion: Dialysate Inlet Pump Occlusion + :param vDialysateOutletPumpOcclusion: Dialysate Outlet Pump Occlusion + :return: built message frame(s) """ msg = messageBuilder.buildMessage( 0x0009, 4+4+4+4+4, False, utils.toF32(vArterialPressure ), @@ -663,12 +674,12 @@ def setPressureOcclusionData (vArterialPressure, vVenousPressure, vBloodPumpOcclusion, vDialysateInletPumpOcclusion, vDialysateOutletPumpOcclusion): """ the Pressure/Occlusion Data messages setter/sender mehtod - :param vArterialPressure: - :param vVenousPressure: - :param vBloodPumpOcclusion: - :param vDialysateInletPumpOcclusion: - :param vDialysateOutletPumpOcclusion: - :return: + :param vArterialPressure: Arterial Pressure + :param vVenousPressure: Venous Pressure + :param vBloodPumpOcclusion: Blood Pump Occlusion + :param vDialysateInletPumpOcclusion: Dialysate Inlet Pump Occlusion + :param vDialysateOutletPumpOcclusion: Dialysate Outlet Pump Occlusion + :return: N/A """ frames = buildPressureOcclusionData(vArterialPressure, vVenousPressure, vBloodPumpOcclusion, vDialysateInletPumpOcclusion, vDialysateOutletPumpOcclusion) frames = messageBuilder.toCandumpFormat(frames) @@ -681,12 +692,14 @@ ## ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ def buildDGROPumpData(vSetPtPressure, vFlowRate, vPWM): """ + the DG RO Pump Data message builder method | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(U32) | #2:(F32) | #3:(F32) | |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: |:--: |:--: | |0x1F00| 0x080 | 8 | 1 Hz | N | DG | All | DG RO Pump Data | \ref Data::mPressure | \ref Data::mFlowRate | \ref Data::mPWM | :param vSetPtPressure: - :param vFlowRate: - :param vPWM: - :return: + :param vSetPtPressure: set Point Pressure + :param vFlowRate: Flow Rate + :param vPWM: PWM + :return: built message frame(s) """ msg = messageBuilder.buildMessage( 0x001F, 4+4+4, False, utils.toI32(vSetPtPressure), @@ -699,10 +712,10 @@ def setDGROPumpData(vSetPtPressure, vFlowRate, vPWM): """ the DG RO Pump Data message setter/sender method - :param vSetPtPressure: - :param vFlowRate: - :param vPWM: - :return: + :param vSetPtPressure: set Point Pressure + :param vFlowRate: Flow Rate + :param vPWM: PWM + :return: N/A """ frames = buildDGROPumpData(vSetPtPressure, vFlowRate, vPWM) frames = messageBuilder.toCandumpFormat(frames) @@ -715,14 +728,15 @@ ## ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ def buildDGPressuresData(vROInletPSI, vROOutletPSI, vDrainInletPSI, vDrainOutletPSI): """ + the DG Pressures Data message builder method | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(F32) | #2:(F32) | #3:(F32) | #4:(F32) | |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: |:--: |:--: |:--: | |0x2000| 0x080 | 8 | 1 Hz | N | DG | All | DG Pressures Data | \ref Data::mROInletPSI | \ref Data::mROOutletPSI | \ref Data::mDrainInletPSI | \ref Data::mDrainOutletPSI | - :param vROInletPSI: - :param vROOutletPSI: - :param vDrainInletPSI: - :param vDrainOutletPSI: - :return: + :param vROInletPSI: RO Inlet PSI + :param vROOutletPSI: RO Outlet PSI + :param vDrainInletPSI: Drain Inlet PSI + :param vDrainOutletPSI: Drain Outlet PSI + :return: built message frame(s) """ msg = messageBuilder.buildMessage( 0x0020, 4+4+4+4, False, utils.toF32(vROInletPSI ), @@ -736,11 +750,11 @@ def setDGPressuresData(vROInletPSI, vROOutletPSI, vDrainInletPSI, vDrainOutletPSI): """ the DG Pressures Data message setter/sender method - :param vROInletPSI: - :param vROOutletPSI: - :param vDrainInletPSI: - :param vDrainOutletPSI: - :return: + :param vROInletPSI: RO Inlet PSI + :param vROOutletPSI: RO Outlet PSI + :param vDrainInletPSI: Drain Inlet PSI + :param vDrainOutletPSI: Drain Outlet PSI + :return: N/A """ frames = buildDGPressuresData(vROInletPSI, vROOutletPSI, vDrainInletPSI, vDrainOutletPSI) frames = messageBuilder.toCandumpFormat(frames) @@ -753,12 +767,13 @@ ## ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ def buildDGDrainPumpData(vSetPtRPM, vDACValue): """ + the DG Drain Pump Data message builder method | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(U32) | #2:(U32) | |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: |:--: | |0x2400| 0x080 | 8 | 1 Hz | N | DG | All | DG Drain Pump Data | \ref Data::mRPM | \ref Data::mDAC | - :param vSetPtRPM: - :param vDACValue: - :return: + :param vSetPtRPM: Set Point RPM + :param vDACValue: DAC Value + :return: built message frame(s) """ msg = messageBuilder.buildMessage( 0x0024, 4+4, False, utils.toI32(vSetPtRPM), @@ -770,9 +785,9 @@ def setDGDrainPumpData(vSetPtRPM, vDACValue): """ the DG Drain Pump Data message setter/sender method - :param vSetPtRPM: - :param vDACValue: - :return: + :param vSetPtRPM: Set Point RPM + :param vDACValue: DAC Value + :return: N/A """ frames = buildDGDrainPumpData(vSetPtRPM, vDACValue) frames = messageBuilder.toCandumpFormat(frames) @@ -785,11 +800,12 @@ ## ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ def buildDGOperationMode(vDGOpMode): """ + the DG Operation Mode Data message builder method | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(U32) | |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: | |0x2700| 0x080 | 8 | 1 Hz | N | DG | All | DG Operation Mode Data | \ref Data::mOpMode | - :param vDGOpMode: - :return: + :param vDGOpMode: DG Operation Mode + :return: built message frame(s) """ msg = messageBuilder.buildMessage( 0x0027, 4, False, utils.toI32(vDGOpMode)) @@ -800,8 +816,8 @@ def setDGOperationMode(vDGOpMode): """ the DG Operation Mode Data message setter/sender method - :param vDGOpMode: - :return: + :param vDGOpMode: DG Operation Mode + :return: N/A """ frames = buildDGOperationMode(vDGOpMode) frames = messageBuilder.toCandumpFormat(frames) @@ -814,13 +830,14 @@ ## ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ def buildDGReservoirData(vActiveReservoir, vFillToVolML, vDrainToVolML): """ + the DG Reservoir Data message builder method | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(U32) | #2:(U32) | #3:(U32) | |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: |:--: |:--: | |0x2800| 0x080 | 8 | 1 Hz | N | DG | All | DG Reservoir Data | \ref Data::mActiveReservoir | \ref Data::mFillToVol | \ref Data::mDrainToVol | - :param vActiveReservoir: - :param vFillToVolML: - :param vDrainToVolML: - :return: + :param vActiveReservoir: Active Reservoir + :param vFillToVolML: Fill To Volume ML + :param vDrainToVolML: Drain To Vol ML + :return: built message frame(s) """ msg = messageBuilder.buildMessage( 0x0028, 4+4+4, False, utils.toI32(vActiveReservoir), @@ -833,10 +850,10 @@ def setDGReservoirData(vActiveReservoir, vFillToVolML, vDrainToVolML): """ the DG Reservoir Data message setter/sender method - :param vActiveReservoir: - :param vFillToVolML: - :param vDrainToVolML: - :return: + :param vActiveReservoir: Active Reservoir + :param vFillToVolML: Fill To Volume ML + :param vDrainToVolML: Drain To Vol ML + :return: N/A """ frames = buildDGReservoirData(vActiveReservoir, vFillToVolML, vDrainToVolML) frames = messageBuilder.toCandumpFormat(frames) @@ -849,11 +866,12 @@ ## ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ def buildDGValvesStates(vValvesStates): """ + the DG Valves States Data message builder method | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(U16) | |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: | |0x2A00| 0x080 | 8 | 2 Hz | N | DG | All | DG Valves States Data | \ref Data::mStates | - :param vValvesStates: - :return: + :param vValvesStates: Valves states + :return: built message frame(s) """ msg = messageBuilder.buildMessage( 0x002A, 2, False, utils.toI16(vValvesStates)) @@ -864,8 +882,8 @@ def setDGValvesStates(vValvesStates): """ the DG Valves States Data message setter/sender method - :param vValvesStates: - :return: + :param vValvesStates: Valves states + :return: N/A """ frames = buildDGValvesStates(vValvesStates) frames = messageBuilder.toCandumpFormat(frames) @@ -878,13 +896,14 @@ ## ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ def buildDGHeatersData(vMainPriMaryDC, vSmallPrimaryDC, vTrimmerDC): """ + the DG Heaters Data message builder method | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(U32) | #2:(U32) | #3:(U32) | |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: |:--: |:--: | |0x2C00| 0x080 | 8 | 2 Hz | N | DG | All | DG Heaters Data | \ref Data::mMainPrimaryDC | \ref Data::mSmallPrimaryDC | \ref Data::mTrimmerDC | - :param vMainPriMaryDC: - :param vSmallPrimaryDC: - :param vTrimmerDC: - :return: + :param vMainPriMaryDC: Main PriMary DC: + :param vSmallPrimaryDC: Small Primary DC: + :param vTrimmerDC: Trimmer DC: + :return: built message frame(s) """ msg = messageBuilder.buildMessage( 0x002C, 4+4+4, False, utils.toI32(vMainPriMaryDC ), @@ -897,10 +916,10 @@ def setDGHeatersData(vMainPriMaryDC, vSmallPrimaryDC, vTrimmerDC): """ the DG Heaters Data message setter/sender method - :param vMainPriMaryDC: - :param vSmallPrimaryDC: - :param vTrimmerDC: - :return: + :param vMainPriMaryDC: Main PriMary DC: + :param vSmallPrimaryDC: Small Primary DC: + :param vTrimmerDC: Trimmer DC: + :return: N/A """ frames = buildDGHeatersData(vMainPriMaryDC, vSmallPrimaryDC, vTrimmerDC) frames = messageBuilder.toCandumpFormat(frames) @@ -913,14 +932,15 @@ ## ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ def buildDGLoadCellReadingsData(vRs1Prim, vRs1Bkup, vRs2Prim, vRs2Bkup): """ + the DG Load Cell Readings Data message builder method | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(F32) | #2:(F32) | #3:(F32) | #4:(F32) | |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: |:--: |:--: |:--: | |0x0C00| 0x080 | 8 | 10 Hz | N | DG | All | DG Load Cell Readings Data | \ref Data::mReservoir1Prim | \ref Data::mReservoir1Bkup | \ref Data::mReservoir2Prim | \ref Data::mReservoir2Bkup | - :param vRs1Prim: - :param vRs1Bkup: - :param vRs2Prim: - :param vRs2Bkup: - :return: + :param vRs1Prim: Reservoir 1 Primary + :param vRs1Bkup: Reservoir 1 Backup + :param vRs2Prim: Reservoir 2 Primary + :param vRs2Bkup: Reservoir 2 Backup + :return: built message frame(s) """ msg = messageBuilder.buildMessage( 0x000C, 4+4+4+4, False, utils.toF32(vRs1Prim), @@ -934,11 +954,11 @@ def setDGLoadCellReadingsData(vRs1Prim, vRs1Bkup, vRs2Prim, vRs2Bkup): """ the DG Load Cell Readings Data message setter/sender method - :param vRs1Prim: - :param vRs1Bkup: - :param vRs2Prim: - :param vRs2Bkup: - :return: + :param vRs1Prim: Reservoir 1 Primary + :param vRs1Bkup: Reservoir 1 Backup + :param vRs2Prim: Reservoir 2 Primary + :param vRs2Bkup: Reservoir 2 Backup + :return: N/A """ frames = buildDGLoadCellReadingsData(vRs1Prim, vRs1Bkup, vRs2Prim, vRs2Bkup) frames = messageBuilder.toCandumpFormat(frames) @@ -951,6 +971,7 @@ ## ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ def buildDGTemperaturesData(vInletPrimaryHeater, vOutletPrimaryHeater, vConductivitySensor1, vConductivitySensor2, vOutletRedundancy, vInletDialysate, vPrimaryHeaterThermocouple, vTrimmerHeaterThermocouple, vPrimaryHeaterColdJunction, vTrimmerHeaterColdJunction, vPrimaryHeaterInternalTemperature, vTrimmerHeaterInternalTemperature): """ + the DG Temperatures Data message builder method | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(F32) | #2:(F32) | #3:(F32) | |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: |:--: |:--: | |0x2D00| 0x080 | 8 | 2 Hz | N | DG | All | DG Temperatures Data | \ref Data::mInletPrimaryHeater | \ref Data::mOutletPrimaryHeater | \ref Data::mConductivitySensor1 | @@ -962,19 +983,19 @@ | #9:(F32) | #10:(F32) | #11:(F32) | #12:(F32) | | :--: |:--: |:--: |:--: | | \ref Data::mPrimaryHeaterColdJunction | \ref Data::mTrimmerHeaterColdJunction | \ref Data::mPrimaryHeaterInternal | \ref Data::mTrimmerHeaterInternal | - :param vInletPrimaryHeater: - :param vOutletPrimaryHeater: - :param vConductivitySensor1: - :param vConductivitySensor2: - :param vOutletRedundancy: - :param vInletDialysate: - :param vPrimaryHeaterThermocouple: - :param vTrimmerHeaterThermocouple: - :param vPrimaryHeaterColdJunction: - :param vTrimmerHeaterColdJunction: - :param vPrimaryHeaterInternalTemperature: - :param vTrimmerHeaterInternalTemperature: - :return: + :param vInletPrimaryHeater: Inlet Primary Heater: + :param vOutletPrimaryHeater: Outlet Primary Heater: + :param vConductivitySensor1: Conductivity Sensor 1: + :param vConductivitySensor2: Conductivity Sensor 2: + :param vOutletRedundancy: Outlet Redundancy: + :param vInletDialysate: Inlet Dialysate: + :param vPrimaryHeaterThermocouple: Primary Heater Thermocouple: + :param vTrimmerHeaterThermocouple: Trimmer Heater Thermocouple: + :param vPrimaryHeaterColdJunction: Primary Heater ColdJunction: + :param vTrimmerHeaterColdJunction: Trimmer Heater ColdJunction: + :param vPrimaryHeaterInternalTemperature: Primary Heater Internal Temperature: + :param vTrimmerHeaterInternalTemperature: Trimmer HeaterInternal Temperature: + :return: built message frame(s) """ msg = messageBuilder.buildMessage( 0x002D, 4+4+4+4+4+4+4+4+4+4+4+4, False, utils.toF32(vInletPrimaryHeater ), @@ -996,19 +1017,19 @@ def setDGTemperaturesData(vInletPrimaryHeater, vOutletPrimaryHeater, vConductivitySensor1, vConductivitySensor2, vOutletRedundancy, vInletDialysate, vPrimaryHeaterThermocouple, vTrimmerHeaterThermocouple, vPrimaryHeaterColdJunction, vTrimmerHeaterColdJunction, vPrimaryHeaterInternalTemperature, vTrimmerHeaterInternalTemperature): """ the DG Temperatures Data message setter/sender method - :param vInletPrimaryHeater: - :param vOutletPrimaryHeater: - :param vConductivitySensor1: - :param vConductivitySensor2: - :param vOutletRedundancy: - :param vInletDialysate: - :param vPrimaryHeaterThermocouple: - :param vTrimmerHeaterThermocouple: - :param vPrimaryHeaterColdJunction: - :param vTrimmerHeaterColdJunction: - :param vPrimaryHeaterInternalTemperature: - :param vTrimmerHeaterInternalTemperature: - :return: + :param vInletPrimaryHeater: Inlet Primary Heater: + :param vOutletPrimaryHeater: Outlet Primary Heater: + :param vConductivitySensor1: Conductivity Sensor 1: + :param vConductivitySensor2: Conductivity Sensor 2: + :param vOutletRedundancy: Outlet Redundancy: + :param vInletDialysate: Inlet Dialysate: + :param vPrimaryHeaterThermocouple: Primary Heater Thermocouple: + :param vTrimmerHeaterThermocouple: Trimmer Heater Thermocouple: + :param vPrimaryHeaterColdJunction: Primary Heater ColdJunction: + :param vTrimmerHeaterColdJunction: Trimmer Heater ColdJunction: + :param vPrimaryHeaterInternalTemperature: Primary Heater Internal Temperature: + :param vTrimmerHeaterInternalTemperature: Trimmer HeaterInternal Temperature: + :return: N/A """ frames = buildDGTemperaturesData(vInletPrimaryHeater, vOutletPrimaryHeater, vConductivitySensor1, vConductivitySensor2, vOutletRedundancy, vInletDialysate, vPrimaryHeaterThermocouple, vTrimmerHeaterThermocouple, vPrimaryHeaterColdJunction, vTrimmerHeaterColdJunction, vPrimaryHeaterInternalTemperature, vTrimmerHeaterInternalTemperature) frames = messageBuilder.toCandumpFormat(frames) @@ -1021,13 +1042,14 @@ ## ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ def buildTreatmentStatesData(vSubMode, vUFState, vSalineState): """ + the Treatment States Data message builder method | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(U32) | #2:(U32) | #3:(U32) | |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: |:--: |:--: | |0x0F00| 0x040 | 7 | 1 Hz | N | HD | All | Treatment States Data | \ref Data::mSubMode | \ref Data::mUFState | \ref Data::mSalineState | - :param vSubMode: - :param vUFState: - :param vSalineState: - :return: + :param vSubMode: Sub-Mode + :param vUFState: UF State + :param vSalineState: Saline Bolus State + :return: built message frame(s) """ msg = messageBuilder.buildMessage( 0x000F, 4+4+4, False, utils.toI32(vSubMode ), @@ -1040,10 +1062,10 @@ def setTreatmentStatesData(vSubMode, vUFState, vSalineState): """ the Treatment States Data message setter/sender method - :param vSubMode: - :param vUFState: - :param vSalineState: - :return: + :param vSubMode: Sub-Mode + :param vUFState: UF State + :param vSalineState: Saline Bolus State + :return: N/A """ frames = buildTreatmentStatesData(vSubMode, vUFState, vSalineState) frames = messageBuilder.toCandumpFormat(frames) @@ -1056,11 +1078,12 @@ ## ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ def buildHDOperationModeData(vOpMode): """ + the HD Operation Mode Data message builder method | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(U32) | |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: | |0x2500| 0x040 | 7 | 1 Hz | N | HD | All | HD Operation Mode Data | \ref Data::mOpMode | - :param vOpMode: - :return: + :param vOpMode: Operation Mode + :return: built message frame(s) """ msg = messageBuilder.buildMessage( 0x0025, 4, False, utils.toI32(vOpMode)) @@ -1071,8 +1094,8 @@ def setHDOperationModeData(vOpMode): """ the HD Operation Mode Data message setter/sender method - :param vOpMode: - :return: + :param vOpMode: Operation Mode + :return: N/A """ frames = buildHDOperationModeData(vOpMode) frames = messageBuilder.toCandumpFormat(frames) @@ -1083,33 +1106,34 @@ ## ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ## ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -def buildTreatmentSalineBolusData(vTarget, vCumulitive, vDelivered): +def buildTreatmentSalineBolusData(vTarget, vCumulative, vDelivered): """ + the Treatment Saline Bolus Data message builder method | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(U32) | #2:(F32) | #3:(F32) | |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: |:--: |:--: | |0x2F00| 0x040 | 7 | 1 Hz | N | HD | All | Treatment Saline Bolus Data | \ref Data::mTarget | \ref Data::mCumulative | \ref Data::mDelivered | - :param vTarget: - :param vCumulitive: - :param vDelivered: - :return: + :param vTarget: Saline Bolus Target Volume + :param vCumulative: Saline Bolus Cumulative Volume + :param vDelivered: Saline Bolus Delivered Volume + :return: built message frame(s) """ msg = messageBuilder.buildMessage( 0x002F, 4+4+4, False, utils.toI32(vTarget ), - utils.toF32(vCumulitive), + utils.toF32(vCumulative), utils.toF32(vDelivered )) return messageBuilder.toFrames(msg) ## ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -def setTreatmentSalineBolusData(vTarget, vCumulitive, vDelivered): +def setTreatmentSalineBolusData(vTarget, vCumulative, vDelivered): """ the Treatment Saline Bolus Data message setter/sender method - :param vTarget: - :param vCumulitive: - :param vDelivered: - :return: + :param vTarget: Saline Bolus Target Volume + :param vCumulative: Saline Bolus Cumulative Volume + :param vDelivered: Saline Bolus Delivered Volume + :return: N/A """ - frames = buildTreatmentSalineBolusData(vTarget, vCumulitive, vDelivered) + frames = buildTreatmentSalineBolusData(vTarget, vCumulative, vDelivered) frames = messageBuilder.toCandumpFormat(frames) for frame in frames: subprocess.call(['cansend', 'can0', '040#{}'.format(frame)]) @@ -1120,13 +1144,14 @@ ## ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ def buildSalineBolusResponse(vAccepted, vReason, vTarget): """ + the Saline Bolus Response message builder method | MSG | CAN ID | M.Box | Type | Ack | Src | Dest | Description | #1:(U32) | #2:(U32) | #3:(U32) | |:---:|:------:|:-----:|:----:|:---:|:---:|:----:|:---------------------:|:--------------------:|:-------------------:|:-------------------:| | 20 | 0x020 | 6 | Rsp | Y | HD | UI | Saline Bolus Response | \ref Data::mAccepted | \ref Data::mReason | \ref Data::mTarget | - :param vAccepted: - :param vReason: - :param vTarget: - :return: + :param vAccepted: boolean accept/reject response + :param vReason: rejection reason + :param vTarget: Saline Bolus Target Volume + :return: built message frame(s) """ msg = messageBuilder.buildMessage( 0x0014, 4+4+4, True, utils.toI32(vAccepted), @@ -1139,10 +1164,10 @@ def setSalineBolusResponse(vAccepted, vReason, vTarget): """ the Saline Bolus Response message setter/sender method - :param vAccepted: - :param vReason: - :param vTarget: - :return: + :param vAccepted: boolean accept/reject response + :param vReason: rejection reason + :param vTarget: Saline Bolus Target Volume + :return: N/A """ frames = buildSalineBolusResponse(vAccepted, vReason, vTarget) frames = messageBuilder.toCandumpFormat(frames) @@ -1154,8 +1179,8 @@ def buildCanBUSFaultCount(vCount): """ the CANBus fault count message builder method - :param vCount: - :return: + :param vCount: Fault Count + :return: built message frame(s) """ msg = messageBuilder.buildMessage(GuiActionType.CanBUSFaultCount, 4 * 1, False, utils.toI32(vCount) @@ -1166,8 +1191,8 @@ def setCanBUSFaultCount(vCount): """ the CANBus fault count message setter/sender method - :param vCount: - :return: + :param vCount: Fault Count + :return: N/A """ frames = buildCanBUSFaultCount(vCount) frames = messageBuilder.toCandumpFormat(frames) @@ -1179,7 +1204,7 @@ def buildUnknown(): """ the unknown message builder method - :return: + :return: built message frame(s) """ msg = messageBuilder.buildMessage(GuiActionType.Unknown, 0, False) return messageBuilder.toFrames(msg) @@ -1188,7 +1213,7 @@ def sendUnknown_HD(): """ the unknown message from HD setter/sender method - :return: + :return: N/A """ frames = buildUnknown() frames = messageBuilder.toCandumpFormat(frames) @@ -1200,7 +1225,7 @@ def sendUnknown_DG(): """ the unknown message from DG setter/sender method - :return: + :return: N/A """ frames = buildUnknown() frames = messageBuilder.toCandumpFormat(frames) @@ -1212,23 +1237,24 @@ def clear_all_alarms(): """ a convenient method for setAlarmStatus to clear all alarms - :return: + :return: N/A """ setAlarmStatus(0, 0, 0, 0, 0) ## ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ## ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ def buildAlarmStatus(vState, vTop, vEscalatesIn, vMuteTimeout, vFlags): """ + the Alarm Status message builder method | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(U32) | #2:(U32) | #3:(U32) | #4:(U32) | #5:(U16) | |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: |:--: |:--: |:--: |:--: | |0x0200| 0x001 | 1 | 1 Hz | N | HD | All | Alarm Status | \ref Data::mState | \ref Data::mTop | \ref Data::mEscalatesIn | \ref Data::mMuteTimeout | \ref Data::mFlags | - :param vState: - :param vTop: - :param vEscalatesIn: - :param vMuteTimeout: - :param vFlags: - :return: + :param vState: Alarm State + :param vTop: Top priority Alaram ID + :param vEscalatesIn: Alarm Escalation + :param vMuteTimeout: Mute Timeout + :param vFlags: Alarm Flags + :return: built message frame(s) """ msg = messageBuilder.buildMessage( 0x0002, 4+4+4+4+2, False, utils.toI32(vState ), @@ -1243,12 +1269,12 @@ def setAlarmStatus (vState, vTop, vEscalatesIn, vMuteTimeout, vFlags): """ the Alarm Status message setter/sender method - :param vState: - :param vTop: - :param vEscalatesIn: - :param vMuteTimeout: - :param vFlags: - :return: + :param vState: Alarm State + :param vTop: Top priority Alaram ID + :param vEscalatesIn: Alarm Escalation + :param vMuteTimeout: Mute Timeout + :param vFlags: Alarm Flags + :return: N/A """ frames = buildAlarmStatus(vState, vTop, vEscalatesIn, vMuteTimeout, vFlags) frames = messageBuilder.toCandumpFormat(frames) @@ -1261,11 +1287,12 @@ ## ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ def buildAlarmTriggered(vAlarmID): """ + the Alarm Triggered message builder method | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(U32) | |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: | |0x0300| 0x001 | 1 | Event | Y | HD | All | Alarm Triggered | \ref Data::mAlarmID | - :param vAlarmID: - :return: + :param vAlarmID: Alarm ID + :return: built message frame(s) """ msg = messageBuilder.buildMessage( 0x0003, 4, True, utils.toI32(vAlarmID)) @@ -1276,8 +1303,8 @@ def setAlarmTriggered(vAlarmID): """ the Alarm Triggered message setter/sender method - :param vAlarmID: - :return: + :param vAlarmID: Alarm ID + :return: N/A """ frames = buildAlarmTriggered(vAlarmID) frames = messageBuilder.toCandumpFormat(frames) @@ -1290,11 +1317,12 @@ ## ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ def buildAlarmCleared(vAlarmID): """ + the Alarm Cleared message builder method | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(U32) | |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: | |0x0400| 0x001 | 1 | Event | Y | HD | All | Alarm Cleared | \ref Data::mAlarmID | - :param vAlarmID: - :return: + :param vAlarmID: Alarm ID + :return: built message frame(s) """ msg = messageBuilder.buildMessage( 0x0004, 4, True, utils.toI32(vAlarmID)) @@ -1305,8 +1333,8 @@ def setAlarmCleared(vAlarmID): """ the Alarm Cleared message setter/sender method - :param vAlarmID: - :return: + :param vAlarmID: Alarm ID + :return: N/A """ frames = buildAlarmCleared(vAlarmID) frames = messageBuilder.toCandumpFormat(frames)