Index: dialin/squish/denaliMessages.py =================================================================== diff -u -rc12fe403b6fd5df2f6c2a25024c35bbcd7a92b84 -r0f258158b67eb47522d8151bcaa237276d1ba547 --- dialin/squish/denaliMessages.py (.../denaliMessages.py) (revision c12fe403b6fd5df2f6c2a25024c35bbcd7a92b84) +++ dialin/squish/denaliMessages.py (.../denaliMessages.py) (revision 0f258158b67eb47522d8151bcaa237276d1ba547) @@ -85,57 +85,57 @@ def send_acknowledge_HD(): """ the acknowledge from HD - :return: N/A + :return: none """ subprocess.call(['cansend', 'can0', '020#A5.01.00.FF.FF.00.19.00']) def send_acknowledge_UI(): """ the acknowledge from UI - :return: N/A + :return: none """ subprocess.call(['cansend', 'can0', '100#A5.01.00.FF.FF.00.19.00']) def send_CheckIn_DG(): """ check-in (keep alive) message from DG - :return: N/A + :return: none """ subprocess.call(['cansend', 'can0', '010#A5.01.00.06.00.00.76.00']) def show_PowerOffDialog(): """ the message from HD to UI to show the power off dialog - :return: N/A + :return: none """ subprocess.call(['cansend', 'can0', '020#A5.01.00.01.00.01.00.38']) def hide_PowerOffDialog(): """ the message from HD to UI to hide the power off dialog - :return: N/A + :return: none """ subprocess.call(['cansend', 'can0', '020#A5.01.00.01.00.01.01.09']) def show_PowerOffNotificationDialog(): """ the message from HD to UI to shew the shutting down notipication box - :return: N/A + :return: none """ subprocess.call(['cansend', 'can0', '040#A5.01.00.0E.00.00.24.00']) def show_PowerOffRejectionDialog(): """ the message from HD to UI to show the power off dialog - :return: N/A + :return: none """ subprocess.call(['cansend', 'can0', '020#A5.01.00.01.00.01.02.5A']) def waitForMessageToBeSent(): """ After each multi-frame message put a 100ms sleep, time.sleep(0.1) # it seems it's needed otherwise the test will check a value which has not been received yet. # - :return: N/A + :return: none """ time.sleep(0.050) # 50ms @@ -144,8 +144,8 @@ def buildHDDebugText(vText): """ the debug text message from HD builder method - :param vText: the debug text - :return: N/A + :param vText: (str) the debug text + :return: none """ len = 40 txt = messageBuilder.textToByte(vText, len) # + 1 null term @@ -155,8 +155,8 @@ def setHDDebugText (vText): """ the debug text message from HD setter/sender method - :param vText: the debug text - :return: N/A + :param vText: (str) the debug text + :return: none """ frames = buildHDDebugText(vText) frames = messageBuilder.toCandumpFormat(frames) @@ -169,8 +169,8 @@ def buildDGDebugText(vText): """ the debug text message from DG builder method - :param vText: the debug text - :return: N/A + :param vText: (str) the debug text + :return: none """ len = 40 txt = messageBuilder.textToByte(vText, len) # + 1 null term @@ -181,8 +181,8 @@ def setDGDebugText (vText): """ the debug text message from DG setter/sender method - :param vText: the debug text - :return: N/A + :param vText: (str) the debug text + :return: none """ frames = buildDGDebugText(vText) frames = messageBuilder.toCandumpFormat(frames) @@ -198,13 +198,13 @@ | 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: 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) + :param vMinTreatmentDuration: (int) Min Treatment Duration + :param vMaxTreatmentDuration: (int) Max Treatment Duration + :param vMinUFVolume: (float) Min UF Volume + :param vMaxUFVolume: (float) Max UF Volume + :param vMinDialysateFlowRate: (int) Min Dialysate Flow Rate + :param vMaxDialysateFlowRate: (int) Max Dialysate Flow Rate + :return: (str) built message frame(s) """ msg = messageBuilder.buildMessage(GuiActionType.TreatmentRanges, 4 * 6, True, utils.toI32(vMinTreatmentDuration), @@ -220,13 +220,13 @@ def setTreatmentParamRanges(vMinTreatmentDuration, vMaxTreatmentDuration, vMinUFVolume, vMaxUFVolume, vMinDialysateFlowRate, vMaxDialysateFlowRate): """ the Treatment adjustment param ranges data message setter/sender method - :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 + :param vMinTreatmentDuration: (int) Min Treatment Duration + :param vMaxTreatmentDuration: (int) Max Treatment Duration + :param vMinUFVolume: (float) Min UF Volume + :param vMaxUFVolume: (float) Max UF Volume + :param vMinDialysateFlowRate: (int) Min Dialysate Flow Rate + :param vMaxDialysateFlowRate: (int) Max Dialysate Flow Rate + :return: none """ frames = buildSetTreatmentParamRanges(vMinTreatmentDuration, vMaxTreatmentDuration, vMinUFVolume, vMaxUFVolume, vMinDialysateFlowRate, vMaxDialysateFlowRate) frames = messageBuilder.toCandumpFormat(frames) @@ -241,14 +241,14 @@ | 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: 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) + :param vFlowSetPt: (uint) Flow Set Point + :param vMeasFlow: (float) Measured Flow + :param vRotSpd: (float) Rot Speed + :param vMotSpd: (float) Motor Speed + :param vMCSpd: (float) MC Speed + :param vMCCurr: (float) MC Current + :param vPWM: (float) PWM + :return: (str) built message frame(s) """ msg = messageBuilder.buildMessage(GuiActionType.BloodFlow, 4 * 7, False, utils.toI32(vFlowSetPt ), @@ -265,14 +265,14 @@ def setTreatmentBloodFlowRate(vFlowSetPt, vMeasFlow, vRotSpd, vMotSpd, vMCSpd, vMCCurr, vPWM): """ the Blood Flow Data message setter/sender method - :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 + :param vFlowSetPt: (uint) Flow Set Point + :param vMeasFlow: (float) Measured Flow + :param vRotSpd: (float) Rot Speed + :param vMotSpd: (float) Motor Speed + :param vMCSpd: (float) MC Speed + :param vMCCurr: (float) MC Current + :param vPWM: (float) PWM + :return: none """ frames = buildSetTreatmentBloodFlowRate(vFlowSetPt, vMeasFlow, vRotSpd, vMotSpd, vMCSpd, vMCCurr, vPWM) frames = messageBuilder.toCandumpFormat(frames) @@ -287,14 +287,14 @@ | 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: 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) + :param vFlowSetPt: (uint) Flow Set Point + :param vMeasFlow: (float) Measured Flow + :param vRotSpd: (float) Rot Speed + :param vMotSpd: (float) Motor Speed + :param vMCSpd: (float) MC Speed + :param vMCCurr: (float) MC Current + :param vPWM: (float) PWM + :return: (str) built message frame(s) """ msg = messageBuilder.buildMessage(GuiActionType.DialysateInletFlow, 4 * 7, False, utils.toI32(vFlowSetPt), @@ -311,14 +311,14 @@ def setTreatmentDialysateFlowRate(vFlowSetPt, vMeasFlow, vRotSpd, vMotSpd, vMCSpd, vMCCurr, vPWM): """ the Dialysate Flow Data message setter/sender method - :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 + :param vFlowSetPt: (uint) Flow Set Point + :param vMeasFlow: (float) Measured Flow + :param vRotSpd: (float) Rot Speed + :param vMotSpd: (float) Motor Speed + :param vMCSpd: (float) MC Speed + :param vMCCurr: (float) MC Current + :param vPWM: (float) PWM + :return: none """ frames = buildSetTreatmentDialysateFlowRate(vFlowSetPt, vMeasFlow, vRotSpd, vMotSpd, vMCSpd, vMCCurr, vPWM) frames = messageBuilder.toCandumpFormat(frames) @@ -333,11 +333,11 @@ | 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: boolean accept/reject response - :param vReason: rejection reason - :param vBloodRate: Blood Flow Rate - :param vDialysate: Dialysate Flow Rate - :return: built message frame(s) + :param vAccepted: (int) boolean accept/reject response + :param vReason: (int) rejection reason + :param vBloodRate: (int) Blood Flow Rate + :param vDialysate: (int) Dialysate Flow Rate + :return: (str) built message frame(s) """ msg = messageBuilder.buildMessage(GuiActionType.AdjustBloodDialysateRsp, 4 * 4, True, utils.toI32(vAccepted), @@ -351,11 +351,11 @@ def sendTreatmentAdjustBloodDialysateResponse(vAccepted, vReason, vBloodRate, vDialysate): """ the Blood/dialysate rate change Response message setter/sender method - :param vAccepted: boolean accept/reject response - :param vReason: rejection reason - :param vBloodRate: Blood Flow Rate - :param vDialysate: Dialysate Flow Rate - :return: N/A + :param vAccepted: (int) boolean accept/reject response + :param vReason: (int) rejection reason + :param vBloodRate: (int) Blood Flow Rate + :param vDialysate: (int) Dialysate Flow Rate + :return: none """ frames = buildTreatmentAdjustBloodDialysateResponse(vAccepted, vReason, vBloodRate, vDialysate) frames = messageBuilder.toCandumpFormat(frames) @@ -370,11 +370,11 @@ | 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: boolean accept/reject response - :param vReason: rejection reason - :param vDuration: Treatment Duration - :param vUltrafiltration: Ultrafiltration Volume - :return: built message frame(s) + :param vAccepted: (int) boolean accept/reject response + :param vReason: (int) rejection reason + :param vDuration: (int) Treatment Duration + :param vUltrafiltration: (float) Ultrafiltration Volume + :return: (str) built message frame(s) """ msg = messageBuilder.buildMessage(GuiActionType.AdjustDurationRsp, 4 * 4, True, utils.toI32(vAccepted), @@ -388,11 +388,11 @@ def sendTreatmentAdjustDurationResponse(vAccepted, vReason, vDuration, vUltrafiltration): """ the Treatment Duration change Response message setter/sender method - :param vAccepted: boolean accept/reject response - :param vReason: rejection reason - :param vDuration: Treatment Duration - :param vUltrafiltration: Ultrafiltration Volume - :return: N/A + :param vAccepted: (int) boolean accept/reject response + :param vReason: (int) rejection reason + :param vDuration: (int) Treatment Duration + :param vUltrafiltration: (float) Ultrafiltration Volume + :return: none """ frames = buildTreatmentAdjustDurationResponse(vAccepted, vReason, vDuration, vUltrafiltration) frames = messageBuilder.toCandumpFormat(frames) @@ -407,8 +407,8 @@ | 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: Ultrafiltionation State - :return: built message frame(s) + :param vState: (int<256) Ultrafiltration State + :return: (str) built message frame(s) """ msg = messageBuilder.buildMessage(GuiActionType.AdjustUltrafiltrationStateReq, 1 * 4 , False, utils.toI32(vState) @@ -420,8 +420,8 @@ """ the Treatment ultrafiltration adjustment response message setter/sender method this is actually the Generic response ACK/NAK message - :param vState: Ultrafiltionation State - :return: N/A + :param vState: (int<256) Ultrafiltration State + :return: none """ frames = buildTreatmentAdjustUltrafiltrationStateResponse(vState) frames = messageBuilder.toCandumpFormat(frames) @@ -433,15 +433,15 @@ def setTreatmentAdjustUltrafiltrationAccepted(): """ a convenient method for setTreatmentAdjustUltrafiltrationStateResponse which sends accept true - :return: N/A + :return: none """ setTreatmentAdjustUltrafiltrationStateResponse( EResponse.Accepted ) def setTreatmentAdjustUltrafiltrationRejected(): """ a convenient method for setTreatmentAdjustUltrafiltrationStateResponse which sends accept false - :return: N/A + :return: none """ setTreatmentAdjustUltrafiltrationStateResponse( EResponse.Rejected ) @@ -452,15 +452,15 @@ | 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: 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) + :param vAccepted: (int) boolean accept/reject response + :param vReason: (int) rejection reason + :param vVolume: (float) Ultrafiltration Volume + :param vDuration: (int) Treatment Duration + :param vDurationDiff: (int) Duration Difference + :param vRate: (float) Ultrafiltration Rate + :param vRateDiff: (float) Ultrafiltration Rate Difference + :param vRateOld: (float) Ultrafiltration Rate Old + :return: (str) built message frame(s) """ msg = messageBuilder.buildMessage(GuiActionType.AdjustUltrafiltrationEditRsp, 8 * 4 , True, utils.toI32(vAccepted), @@ -478,15 +478,15 @@ def setTreatmentAdjustUltrafiltrationEditResponse(vAccepted, vReason, vVolume, vDuration, vDurationDiff, vRate, vRateDiff, vRateOld): """ the ultrafiltration volume change response message setter/sender method - :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 + :param vAccepted: (int) boolean accept/reject response + :param vReason: (int) rejection reason + :param vVolume: (float) Ultrafiltration Volume + :param vDuration: (int) Treatment Duration + :param vDurationDiff: (int) Duration Difference + :param vRate: (float) Ultrafiltration Rate + :param vRateDiff: (float) Ultrafiltration Rate Difference + :param vRateOld: (float) Ultrafiltration Rate Old + :return: none """ frames = buildTreatmentAdjustUltrafiltrationEditResponse(vAccepted, vReason, vVolume, vDuration, vDurationDiff, vRate, vRateDiff, vRateOld) frames = messageBuilder.toCandumpFormat(frames) @@ -499,8 +499,8 @@ """ a convenient method for setTreatmentAdjustUltrafiltrationEditResponse which only sends a rejection reason and sends other values all as zero - :param vReason: rejection reason - :return: N/A + :param vReason: (int) rejection reason + :return: none """ frames = buildTreatmentAdjustUltrafiltrationEditResponse(0, vReason, 0, 0, 0, 0, 0, 0) frames = messageBuilder.toCandumpFormat(frames) @@ -515,11 +515,11 @@ | 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: boolean accept/reject response - :param vReason: rejection reason - :param vVolume: Ultrafiltration Volume - :param vDuration: Treatment Duration - :param vRate: Ultrafiltration Rate + :param vAccepted: (int) boolean accept/reject response + :param vReason: (int) rejection reason + :param vVolume: (float) Ultrafiltration Volume + :param vDuration: (int) Treatment Duration + :param vRate: (float) Ultrafiltration Rate :return: built message frame(s) """ msg = messageBuilder.buildMessage(GuiActionType.AdjustUltrafiltrationConfirmRsp, 5 * 4 , True, @@ -534,13 +534,13 @@ def setTreatmentAdjustUltrafiltrationConfirmResponse (vAccepted, vReason, vVolume, vDuration, vRate): """ - the ultrafiltratin volume Change Confirmation Response message setter/sender method - :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 + the ultrafiltration volume Change Confirmation Response message setter/sender method + :param vAccepted: (int) boolean accept/reject response + :param vReason: (int) rejection reason + :param vVolume: (float) Ultrafiltration Volume + :param vDuration: (int) Treatment Duration + :param vRate: (float) Ultrafiltration Rate + :return: none """ frames = buildTreatmentAdjustUltrafiltrationConfirmResponse(vAccepted, vReason, vVolume, vDuration, vRate) frames = messageBuilder.toCandumpFormat(frames) @@ -553,9 +553,8 @@ """ a convenient method for setTreatmentAdjustUltrafiltrationConfirmResponse which only sends a rejection reason and sends other values all as zero - - :param vReason: rejection reason - :return: N/A + :param vReason: (int) rejection reason + :return: none """ frames = buildTreatmentAdjustUltrafiltrationConfirmResponse(0, vReason, 0, 0, 0) frames = messageBuilder.toCandumpFormat(frames) @@ -570,10 +569,10 @@ | 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: 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) + :param vSecsTotal: (int) Treatment Total Duration in Seconds + :param vSecsElap: (int) Treatment Total Elapsed Time in Seconds + :param vSecsRem: (int) Treatment Remaining Time in Seconds + :return: (str) built message frame(s) """ msg = messageBuilder.buildMessage(GuiActionType.TreatmentTime, 3 * 4, False, utils.toI32(vSecsTotal), @@ -586,10 +585,10 @@ def setTreatmentTime(vSecsTotal, vSecsElap, vSecsRem = None): """ the Treatment Time Data message setter/sender method - :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 + :param vSecsTotal: (int) Treatment Total Duration in Seconds + :param vSecsElap: (int) Treatment Total Elapsed Time in Seconds + :param vSecsRem: (int) Treatment Remaining Time in Seconds + :return: none """ if vSecsRem == None: vSecsRem = vSecsTotal - vSecsElap @@ -606,14 +605,14 @@ | 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: 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) + :param vRefUFVol: (float) Ref UF Volume + :param vMeasUFVol: (float) Measured UF Volume + :param vRotSpd: (float) Rot Speed + :param vMotSpd: (float) Motor Speed + :param vMCSpd: (float) MC Speed + :param vMCCurr: (float) MC Current + :param vPWM: (float) PWM + :return: (str) built message frame(s) """ msg = messageBuilder.buildMessage(GuiActionType.DialysateOutletFlow, 4 * 7, False, utils.toF32(vRefUFVol), @@ -630,14 +629,14 @@ def setTreatmentUltrafiltration(vRefUFVol, vMeasUFVol, vRotSpd, vMotSpd, vMCSpd, vMCCurr, vPWM): """ the Outlet Flow Data message setter/sender method - :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 + :param vRefUFVol: (float) Ref UF Volume + :param vMeasUFVol: (float) Measured UF Volume + :param vRotSpd: (float) Rot Speed + :param vMotSpd: (float) Motor Speed + :param vMCSpd: (float) MC Speed + :param vMCCurr: (float) MC Current + :param vPWM: (float) PWM + :return: none """ frames = buildSetTreatmentUltrafiltration(vRefUFVol, vMeasUFVol, vRotSpd, vMotSpd, vMCSpd, vMCCurr, vPWM ) frames = messageBuilder.toCandumpFormat(frames) @@ -654,12 +653,12 @@ | 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: 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) + :param vArterialPressure: (float) Arterial Pressure + :param vVenousPressure: (float) Venous Pressure + :param vBloodPumpOcclusion: (float) Blood Pump Occlusion + :param vDialysateInletPumpOcclusion: (float) Dialysate Inlet Pump Occlusion + :param vDialysateOutletPumpOcclusion: (float) Dialysate Outlet Pump Occlusion + :return: (str) built message frame(s) """ msg = messageBuilder.buildMessage( 0x0009, 4+4+4+4+4, False, utils.toF32(vArterialPressure ), @@ -674,12 +673,12 @@ def setPressureOcclusionData (vArterialPressure, vVenousPressure, vBloodPumpOcclusion, vDialysateInletPumpOcclusion, vDialysateOutletPumpOcclusion): """ the Pressure/Occlusion Data messages setter/sender mehtod - :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 + :param vArterialPressure: (float) Arterial Pressure + :param vVenousPressure: (float) Venous Pressure + :param vBloodPumpOcclusion: (float) Blood Pump Occlusion + :param vDialysateInletPumpOcclusion: (float) Dialysate Inlet Pump Occlusion + :param vDialysateOutletPumpOcclusion: (float) Dialysate Outlet Pump Occlusion + :return: none """ frames = buildPressureOcclusionData(vArterialPressure, vVenousPressure, vBloodPumpOcclusion, vDialysateInletPumpOcclusion, vDialysateOutletPumpOcclusion) frames = messageBuilder.toCandumpFormat(frames) @@ -696,10 +695,10 @@ | 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 vSetPtPressure: set Point Pressure - :param vFlowRate: Flow Rate - :param vPWM: PWM - :return: built message frame(s) + :param vSetPtPressure: (int) set Point Pressure + :param vFlowRate: (float) Flow Rate + :param vPWM: (float) PWM + :return: (str) built message frame(s) """ msg = messageBuilder.buildMessage( 0x001F, 4+4+4, False, utils.toI32(vSetPtPressure), @@ -712,10 +711,10 @@ def setDGROPumpData(vSetPtPressure, vFlowRate, vPWM): """ the DG RO Pump Data message setter/sender method - :param vSetPtPressure: set Point Pressure - :param vFlowRate: Flow Rate - :param vPWM: PWM - :return: N/A + :param vSetPtPressure: (int) set Point Pressure + :param vFlowRate: (float) Flow Rate + :param vPWM: (float) PWM + :return: none """ frames = buildDGROPumpData(vSetPtPressure, vFlowRate, vPWM) frames = messageBuilder.toCandumpFormat(frames) @@ -732,11 +731,11 @@ | 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: RO Inlet PSI - :param vROOutletPSI: RO Outlet PSI - :param vDrainInletPSI: Drain Inlet PSI - :param vDrainOutletPSI: Drain Outlet PSI - :return: built message frame(s) + :param vROInletPSI: (float) RO Inlet PSI + :param vROOutletPSI: (float) RO Outlet PSI + :param vDrainInletPSI: (float) Drain Inlet PSI + :param vDrainOutletPSI: (float) Drain Outlet PSI + :return: (str) built message frame(s) """ msg = messageBuilder.buildMessage( 0x0020, 4+4+4+4, False, utils.toF32(vROInletPSI ), @@ -750,11 +749,11 @@ def setDGPressuresData(vROInletPSI, vROOutletPSI, vDrainInletPSI, vDrainOutletPSI): """ the DG Pressures Data message setter/sender method - :param vROInletPSI: RO Inlet PSI - :param vROOutletPSI: RO Outlet PSI - :param vDrainInletPSI: Drain Inlet PSI - :param vDrainOutletPSI: Drain Outlet PSI - :return: N/A + :param vROInletPSI: (float) RO Inlet PSI + :param vROOutletPSI: (float) RO Outlet PSI + :param vDrainInletPSI: (float) Drain Inlet PSI + :param vDrainOutletPSI: (float) Drain Outlet PSI + :return: none """ frames = buildDGPressuresData(vROInletPSI, vROOutletPSI, vDrainInletPSI, vDrainOutletPSI) frames = messageBuilder.toCandumpFormat(frames) @@ -771,9 +770,9 @@ | 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: Set Point RPM - :param vDACValue: DAC Value - :return: built message frame(s) + :param vSetPtRPM: (int) Set Point RPM + :param vDACValue: (int) DAC Value + :return: (str) built message frame(s) """ msg = messageBuilder.buildMessage( 0x0024, 4+4, False, utils.toI32(vSetPtRPM), @@ -785,9 +784,9 @@ def setDGDrainPumpData(vSetPtRPM, vDACValue): """ the DG Drain Pump Data message setter/sender method - :param vSetPtRPM: Set Point RPM - :param vDACValue: DAC Value - :return: N/A + :param vSetPtRPM: (int) Set Point RPM + :param vDACValue: (int) DAC Value + :return: none """ frames = buildDGDrainPumpData(vSetPtRPM, vDACValue) frames = messageBuilder.toCandumpFormat(frames) @@ -804,8 +803,8 @@ | 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: DG Operation Mode - :return: built message frame(s) + :param vDGOpMode: (int) DG Operation Mode + :return: (str) built message frame(s) """ msg = messageBuilder.buildMessage( 0x0027, 4, False, utils.toI32(vDGOpMode)) @@ -816,8 +815,8 @@ def setDGOperationMode(vDGOpMode): """ the DG Operation Mode Data message setter/sender method - :param vDGOpMode: DG Operation Mode - :return: N/A + :param vDGOpMode: (int) DG Operation Mode + :return: none """ frames = buildDGOperationMode(vDGOpMode) frames = messageBuilder.toCandumpFormat(frames) @@ -834,10 +833,10 @@ | 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: Active Reservoir - :param vFillToVolML: Fill To Volume ML - :param vDrainToVolML: Drain To Vol ML - :return: built message frame(s) + :param vActiveReservoir: (int) Active Reservoir + :param vFillToVolML: (int) Fill To Volume ML + :param vDrainToVolML: (int) Drain To Vol ML + :return: (str) built message frame(s) """ msg = messageBuilder.buildMessage( 0x0028, 4+4+4, False, utils.toI32(vActiveReservoir), @@ -850,10 +849,10 @@ def setDGReservoirData(vActiveReservoir, vFillToVolML, vDrainToVolML): """ the DG Reservoir Data message setter/sender method - :param vActiveReservoir: Active Reservoir - :param vFillToVolML: Fill To Volume ML - :param vDrainToVolML: Drain To Vol ML - :return: N/A + :param vActiveReservoir: (int) Active Reservoir + :param vFillToVolML: (int) Fill To Volume ML + :param vDrainToVolML: (int) Drain To Vol ML + :return: none """ frames = buildDGReservoirData(vActiveReservoir, vFillToVolML, vDrainToVolML) frames = messageBuilder.toCandumpFormat(frames) @@ -870,8 +869,8 @@ | 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: Valves states - :return: built message frame(s) + :param vValvesStates: (int)Valves states + :return: (str) built message frame(s) """ msg = messageBuilder.buildMessage( 0x002A, 2, False, utils.toI16(vValvesStates)) @@ -882,8 +881,8 @@ def setDGValvesStates(vValvesStates): """ the DG Valves States Data message setter/sender method - :param vValvesStates: Valves states - :return: N/A + :param vValvesStates: (int)Valves states + :return: none """ frames = buildDGValvesStates(vValvesStates) frames = messageBuilder.toCandumpFormat(frames) @@ -900,10 +899,10 @@ | 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: Main PriMary DC: - :param vSmallPrimaryDC: Small Primary DC: - :param vTrimmerDC: Trimmer DC: - :return: built message frame(s) + :param vMainPriMaryDC: (int) Main PriMary DC + :param vSmallPrimaryDC: (int) Small Primary DC + :param vTrimmerDC: (int) Trimmer DC + :return: (str) built message frame(s) """ msg = messageBuilder.buildMessage( 0x002C, 4+4+4, False, utils.toI32(vMainPriMaryDC ), @@ -916,10 +915,10 @@ def setDGHeatersData(vMainPriMaryDC, vSmallPrimaryDC, vTrimmerDC): """ the DG Heaters Data message setter/sender method - :param vMainPriMaryDC: Main PriMary DC: - :param vSmallPrimaryDC: Small Primary DC: - :param vTrimmerDC: Trimmer DC: - :return: N/A + :param vMainPriMaryDC: (int) Main PriMary DC + :param vSmallPrimaryDC: (int) Small Primary DC + :param vTrimmerDC: (int) Trimmer DC + :return: none """ frames = buildDGHeatersData(vMainPriMaryDC, vSmallPrimaryDC, vTrimmerDC) frames = messageBuilder.toCandumpFormat(frames) @@ -936,11 +935,11 @@ | 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: Reservoir 1 Primary - :param vRs1Bkup: Reservoir 1 Backup - :param vRs2Prim: Reservoir 2 Primary - :param vRs2Bkup: Reservoir 2 Backup - :return: built message frame(s) + :param vRs1Prim: (float) Reservoir 1 Primary + :param vRs1Bkup: (float) Reservoir 1 Backup + :param vRs2Prim: (float) Reservoir 2 Primary + :param vRs2Bkup: (float) Reservoir 2 Backup + :return: (str) built message frame(s) """ msg = messageBuilder.buildMessage( 0x000C, 4+4+4+4, False, utils.toF32(vRs1Prim), @@ -954,11 +953,11 @@ def setDGLoadCellReadingsData(vRs1Prim, vRs1Bkup, vRs2Prim, vRs2Bkup): """ the DG Load Cell Readings Data message setter/sender method - :param vRs1Prim: Reservoir 1 Primary - :param vRs1Bkup: Reservoir 1 Backup - :param vRs2Prim: Reservoir 2 Primary - :param vRs2Bkup: Reservoir 2 Backup - :return: N/A + :param vRs1Prim: (float) Reservoir 1 Primary + :param vRs1Bkup: (float) Reservoir 1 Backup + :param vRs2Prim: (float) Reservoir 2 Primary + :param vRs2Bkup: (float) Reservoir 2 Backup + :return: none """ frames = buildDGLoadCellReadingsData(vRs1Prim, vRs1Bkup, vRs2Prim, vRs2Bkup) frames = messageBuilder.toCandumpFormat(frames) @@ -983,19 +982,19 @@ | #9:(F32) | #10:(F32) | #11:(F32) | #12:(F32) | | :--: |:--: |:--: |:--: | | \ref Data::mPrimaryHeaterColdJunction | \ref Data::mTrimmerHeaterColdJunction | \ref Data::mPrimaryHeaterInternal | \ref Data::mTrimmerHeaterInternal | - :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) + :param vInletPrimaryHeater: (float) Inlet Primary Heater + :param vOutletPrimaryHeater: (float) Outlet Primary Heater + :param vConductivitySensor1: (float) Conductivity Sensor 1 + :param vConductivitySensor2: (float) Conductivity Sensor 2 + :param vOutletRedundancy: (float) Outlet Redundancy + :param vInletDialysate: (float) Inlet Dialysate + :param vPrimaryHeaterThermocouple: (float) Primary Heater Thermocouple + :param vTrimmerHeaterThermocouple: (float) Trimmer Heater Thermocouple + :param vPrimaryHeaterColdJunction: (float) Primary Heater ColdJunction + :param vTrimmerHeaterColdJunction: (float) Trimmer Heater ColdJunction + :param vPrimaryHeaterInternalTemperature: (float) Primary Heater Internal Temperature + :param vTrimmerHeaterInternalTemperature: (float) Trimmer HeaterInternal Temperature + :return: (str) built message frame(s) """ msg = messageBuilder.buildMessage( 0x002D, 4+4+4+4+4+4+4+4+4+4+4+4, False, utils.toF32(vInletPrimaryHeater ), @@ -1017,19 +1016,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: 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 + :param vInletPrimaryHeater: (float) Inlet Primary Heater + :param vOutletPrimaryHeater: (float) Outlet Primary Heater + :param vConductivitySensor1: (float) Conductivity Sensor 1 + :param vConductivitySensor2: (float) Conductivity Sensor 2 + :param vOutletRedundancy: (float) Outlet Redundancy + :param vInletDialysate: (float) Inlet Dialysate + :param vPrimaryHeaterThermocouple: (float) Primary Heater Thermocouple + :param vTrimmerHeaterThermocouple: (float) Trimmer Heater Thermocouple + :param vPrimaryHeaterColdJunction: (float) Primary Heater ColdJunction + :param vTrimmerHeaterColdJunction: (float) Trimmer Heater ColdJunction + :param vPrimaryHeaterInternalTemperature: (float) Primary Heater Internal Temperature + :param vTrimmerHeaterInternalTemperature: (float) Trimmer HeaterInternal Temperature + :return: none """ frames = buildDGTemperaturesData(vInletPrimaryHeater, vOutletPrimaryHeater, vConductivitySensor1, vConductivitySensor2, vOutletRedundancy, vInletDialysate, vPrimaryHeaterThermocouple, vTrimmerHeaterThermocouple, vPrimaryHeaterColdJunction, vTrimmerHeaterColdJunction, vPrimaryHeaterInternalTemperature, vTrimmerHeaterInternalTemperature) frames = messageBuilder.toCandumpFormat(frames) @@ -1046,10 +1045,10 @@ | 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: Sub-Mode - :param vUFState: UF State - :param vSalineState: Saline Bolus State - :return: built message frame(s) + :param vSubMode: (int) Sub-Mode + :param vUFState: (int) UF State + :param vSalineState: (int) Saline Bolus State + :return: (str) built message frame(s) """ msg = messageBuilder.buildMessage( 0x000F, 4+4+4, False, utils.toI32(vSubMode ), @@ -1062,10 +1061,10 @@ def setTreatmentStatesData(vSubMode, vUFState, vSalineState): """ the Treatment States Data message setter/sender method - :param vSubMode: Sub-Mode - :param vUFState: UF State - :param vSalineState: Saline Bolus State - :return: N/A + :param vSubMode: (int) Sub-Mode + :param vUFState: (int) UF State + :param vSalineState: (int) Saline Bolus State + :return: none """ frames = buildTreatmentStatesData(vSubMode, vUFState, vSalineState) frames = messageBuilder.toCandumpFormat(frames) @@ -1082,8 +1081,8 @@ | 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: Operation Mode - :return: built message frame(s) + :param vOpMode: (int) Operation Mode + :return: (str) built message frame(s) """ msg = messageBuilder.buildMessage( 0x0025, 4, False, utils.toI32(vOpMode)) @@ -1094,8 +1093,8 @@ def setHDOperationModeData(vOpMode): """ the HD Operation Mode Data message setter/sender method - :param vOpMode: Operation Mode - :return: N/A + :param vOpMode: (int) Operation Mode + :return: none """ frames = buildHDOperationModeData(vOpMode) frames = messageBuilder.toCandumpFormat(frames) @@ -1112,10 +1111,10 @@ | 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: Saline Bolus Target Volume - :param vCumulative: Saline Bolus Cumulative Volume - :param vDelivered: Saline Bolus Delivered Volume - :return: built message frame(s) + :param vTarget: (int) Saline Bolus Target Volume + :param vCumulative: (float) Saline Bolus Cumulative Volume + :param vDelivered: (float) Saline Bolus Delivered Volume + :return: (str) built message frame(s) """ msg = messageBuilder.buildMessage( 0x002F, 4+4+4, False, utils.toI32(vTarget ), @@ -1128,10 +1127,10 @@ def setTreatmentSalineBolusData(vTarget, vCumulative, vDelivered): """ the Treatment Saline Bolus Data message setter/sender method - :param vTarget: Saline Bolus Target Volume - :param vCumulative: Saline Bolus Cumulative Volume - :param vDelivered: Saline Bolus Delivered Volume - :return: N/A + :param vTarget: (int) Saline Bolus Target Volume + :param vCumulative: (float) Saline Bolus Cumulative Volume + :param vDelivered: (float) Saline Bolus Delivered Volume + :return: none """ frames = buildTreatmentSalineBolusData(vTarget, vCumulative, vDelivered) frames = messageBuilder.toCandumpFormat(frames) @@ -1148,10 +1147,10 @@ | 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: boolean accept/reject response - :param vReason: rejection reason - :param vTarget: Saline Bolus Target Volume - :return: built message frame(s) + :param vAccepted: (int) boolean accept/reject response + :param vReason: (int) rejection reason + :param vTarget: (int) Saline Bolus Target Volume + :return: (str) built message frame(s) """ msg = messageBuilder.buildMessage( 0x0014, 4+4+4, True, utils.toI32(vAccepted), @@ -1164,10 +1163,10 @@ def setSalineBolusResponse(vAccepted, vReason, vTarget): """ the Saline Bolus Response message setter/sender method - :param vAccepted: boolean accept/reject response - :param vReason: rejection reason - :param vTarget: Saline Bolus Target Volume - :return: N/A + :param vAccepted: (int) boolean accept/reject response + :param vReason: (int) rejection reason + :param vTarget: (int) Saline Bolus Target Volume + :return: none """ frames = buildSalineBolusResponse(vAccepted, vReason, vTarget) frames = messageBuilder.toCandumpFormat(frames) @@ -1179,8 +1178,8 @@ def buildCanBUSFaultCount(vCount): """ the CANBus fault count message builder method - :param vCount: Fault Count - :return: built message frame(s) + :param vCount: (int) Fault Count + :return: (str) built message frame(s) """ msg = messageBuilder.buildMessage(GuiActionType.CanBUSFaultCount, 4 * 1, False, utils.toI32(vCount) @@ -1191,8 +1190,8 @@ def setCanBUSFaultCount(vCount): """ the CANBus fault count message setter/sender method - :param vCount: Fault Count - :return: N/A + :param vCount: (int) Fault Count + :return: none """ frames = buildCanBUSFaultCount(vCount) frames = messageBuilder.toCandumpFormat(frames) @@ -1204,7 +1203,7 @@ def buildUnknown(): """ the unknown message builder method - :return: built message frame(s) + :return: (str) built message frame(s) """ msg = messageBuilder.buildMessage(GuiActionType.Unknown, 0, False) return messageBuilder.toFrames(msg) @@ -1213,7 +1212,7 @@ def sendUnknown_HD(): """ the unknown message from HD setter/sender method - :return: N/A + :return: none """ frames = buildUnknown() frames = messageBuilder.toCandumpFormat(frames) @@ -1225,7 +1224,7 @@ def sendUnknown_DG(): """ the unknown message from DG setter/sender method - :return: N/A + :return: none """ frames = buildUnknown() frames = messageBuilder.toCandumpFormat(frames) @@ -1237,7 +1236,7 @@ def clear_all_alarms(): """ a convenient method for setAlarmStatus to clear all alarms - :return: N/A + :return: none """ setAlarmStatus(0, 0, 0, 0, 0) @@ -1249,12 +1248,12 @@ | 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: 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) + :param vState: (int) Alarm State + :param vTop: (int) Top priority Alaram ID + :param vEscalatesIn: (int) Alarm Escalation + :param vMuteTimeout: (int) Mute Timeout + :param vFlags: (int16) Alarm Flags + :return: (str) built message frame(s) """ msg = messageBuilder.buildMessage( 0x0002, 4+4+4+4+2, False, utils.toI32(vState ), @@ -1269,12 +1268,12 @@ def setAlarmStatus (vState, vTop, vEscalatesIn, vMuteTimeout, vFlags): """ the Alarm Status message setter/sender method - :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 + :param vState: (int) Alarm State + :param vTop: (int) Top priority Alaram ID + :param vEscalatesIn: (int) Alarm Escalation + :param vMuteTimeout: (int) Mute Timeout + :param vFlags: (int16) Alarm Flags + :return: none """ frames = buildAlarmStatus(vState, vTop, vEscalatesIn, vMuteTimeout, vFlags) frames = messageBuilder.toCandumpFormat(frames) @@ -1291,8 +1290,8 @@ | 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: Alarm ID - :return: built message frame(s) + :param vAlarmID: (int) Alarm ID + :return: (str) built message frame(s) """ msg = messageBuilder.buildMessage( 0x0003, 4, True, utils.toI32(vAlarmID)) @@ -1303,8 +1302,8 @@ def setAlarmTriggered(vAlarmID): """ the Alarm Triggered message setter/sender method - :param vAlarmID: Alarm ID - :return: N/A + :param vAlarmID: (int) Alarm ID + :return: none """ frames = buildAlarmTriggered(vAlarmID) frames = messageBuilder.toCandumpFormat(frames) @@ -1321,8 +1320,8 @@ | 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: Alarm ID - :return: built message frame(s) + :param vAlarmID: (int) Alarm ID + :return: (str) built message frame(s) """ msg = messageBuilder.buildMessage( 0x0004, 4, True, utils.toI32(vAlarmID)) @@ -1333,8 +1332,8 @@ def setAlarmCleared(vAlarmID): """ the Alarm Cleared message setter/sender method - :param vAlarmID: Alarm ID - :return: N/A + :param vAlarmID: (int) Alarm ID + :return: none """ frames = buildAlarmCleared(vAlarmID) frames = messageBuilder.toCandumpFormat(frames)