You are reading the documentation for the main branch, which may contain unreleased changes. The most recent release is v0.1.0.
pnpq.apt package#
Submodules#
- pnpq.apt.connection module
- pnpq.apt.protocol module
ATSAddressAptMessageAptMessageForStreamParsingAptMessageHeaderOnlyAptMessageHeaderOnlyChanEnableStateAptMessageHeaderOnlyChanIdentAptMessageHeaderOnlyNoParamsAptMessageIdAptMessageId.MGMSG_HW_DISCONNECTAptMessageId.MGMSG_HW_GET_INFOAptMessageId.MGMSG_HW_REQ_INFOAptMessageId.MGMSG_HW_START_UPDATEMSGSAptMessageId.MGMSG_HW_STOP_UPDATEMSGSAptMessageId.MGMSG_MOD_GET_CHANENABLESTATEAptMessageId.MGMSG_MOD_IDENTIFYAptMessageId.MGMSG_MOD_REQ_CHANENABLESTATEAptMessageId.MGMSG_MOD_SET_CHANENABLESTATEAptMessageId.MGMSG_MOT_ACK_USTATUSUPDATEAptMessageId.MGMSG_MOT_GET_HOMEPARAMSAptMessageId.MGMSG_MOT_GET_JOGPARAMSAptMessageId.MGMSG_MOT_GET_POSCOUNTERAptMessageId.MGMSG_MOT_GET_STATUSUPDATEAptMessageId.MGMSG_MOT_GET_USTATUSUPDATEAptMessageId.MGMSG_MOT_GET_VELPARAMSAptMessageId.MGMSG_MOT_MOVE_ABSOLUTEAptMessageId.MGMSG_MOT_MOVE_COMPLETEDAptMessageId.MGMSG_MOT_MOVE_HOMEAptMessageId.MGMSG_MOT_MOVE_HOMEDAptMessageId.MGMSG_MOT_MOVE_JOGAptMessageId.MGMSG_MOT_MOVE_STOPAptMessageId.MGMSG_MOT_MOVE_STOPPEDAptMessageId.MGMSG_MOT_REQ_HOMEPARAMSAptMessageId.MGMSG_MOT_REQ_JOGPARAMSAptMessageId.MGMSG_MOT_REQ_POSCOUNTERAptMessageId.MGMSG_MOT_REQ_STATUSUPDATEAptMessageId.MGMSG_MOT_REQ_USTATUSUPDATEAptMessageId.MGMSG_MOT_REQ_VELPARAMSAptMessageId.MGMSG_MOT_RESUME_ENDOFMOVEMSGSAptMessageId.MGMSG_MOT_SET_EEPROMPARAMSAptMessageId.MGMSG_MOT_SET_HOMEPARAMSAptMessageId.MGMSG_MOT_SET_JOGPARAMSAptMessageId.MGMSG_MOT_SET_POSCOUNTERAptMessageId.MGMSG_MOT_SET_VELPARAMSAptMessageId.MGMSG_POL_GET_PARAMSAptMessageId.MGMSG_POL_REQ_PARAMSAptMessageId.MGMSG_POL_SET_PARAMSAptMessageId.MGMSG_RESTOREFACTORYSETTINGS
AptMessageWithDataAptMessageWithDataMotorStatusAptMessageWithDataMotorStatus.chan_identAptMessageWithDataMotorStatus.data_lengthAptMessageWithDataMotorStatus.from_bytes()AptMessageWithDataMotorStatus.message_structAptMessageWithDataMotorStatus.motor_currentAptMessageWithDataMotorStatus.positionAptMessageWithDataMotorStatus.statusAptMessageWithDataMotorStatus.to_bytes()AptMessageWithDataMotorStatus.velocity
AptMessageWithDataPolParamsAptMessageWithDataPolParams.data_lengthAptMessageWithDataPolParams.from_bytes()AptMessageWithDataPolParams.home_positionAptMessageWithDataPolParams.jog_step_1AptMessageWithDataPolParams.jog_step_2AptMessageWithDataPolParams.jog_step_3AptMessageWithDataPolParams.message_structAptMessageWithDataPolParams.to_bytes()AptMessageWithDataPolParams.unusedAptMessageWithDataPolParams.velocity
AptMessageWithDataPositionAptMessageWithDataVelParamsAptMessageWithDataVelParams.accelerationAptMessageWithDataVelParams.chan_identAptMessageWithDataVelParams.data_lengthAptMessageWithDataVelParams.from_bytes()AptMessageWithDataVelParams.maximum_velocityAptMessageWithDataVelParams.message_structAptMessageWithDataVelParams.minimum_velocityAptMessageWithDataVelParams.to_bytes()
AptMessageWithHomeParamsAptMessageWithHomeParams.chan_identAptMessageWithHomeParams.data_lengthAptMessageWithHomeParams.from_bytes()AptMessageWithHomeParams.home_directionAptMessageWithHomeParams.home_velocityAptMessageWithHomeParams.limit_switchAptMessageWithHomeParams.message_structAptMessageWithHomeParams.offset_distanceAptMessageWithHomeParams.to_bytes()
AptMessageWithJogParamsAptMessageWithJogParams.chan_identAptMessageWithJogParams.data_lengthAptMessageWithJogParams.from_bytes()AptMessageWithJogParams.jog_accelerationAptMessageWithJogParams.jog_maximum_velocityAptMessageWithJogParams.jog_minimum_velocityAptMessageWithJogParams.jog_modeAptMessageWithJogParams.jog_step_sizeAptMessageWithJogParams.jog_stop_modeAptMessageWithJogParams.message_structAptMessageWithJogParams.to_bytes()
AptMessage_MGMSG_HW_DISCONNECTAptMessage_MGMSG_HW_GET_INFOAptMessage_MGMSG_HW_GET_INFO.data_lengthAptMessage_MGMSG_HW_GET_INFO.firmware_versionAptMessage_MGMSG_HW_GET_INFO.from_bytes()AptMessage_MGMSG_HW_GET_INFO.hardware_typeAptMessage_MGMSG_HW_GET_INFO.hardware_versionAptMessage_MGMSG_HW_GET_INFO.internal_useAptMessage_MGMSG_HW_GET_INFO.message_idAptMessage_MGMSG_HW_GET_INFO.message_structAptMessage_MGMSG_HW_GET_INFO.model_numberAptMessage_MGMSG_HW_GET_INFO.modification_stateAptMessage_MGMSG_HW_GET_INFO.number_of_channelsAptMessage_MGMSG_HW_GET_INFO.serial_numberAptMessage_MGMSG_HW_GET_INFO.to_bytes()
AptMessage_MGMSG_HW_REQ_INFOAptMessage_MGMSG_HW_START_UPDATEMSGSAptMessage_MGMSG_HW_STOP_UPDATEMSGSAptMessage_MGMSG_MOD_GET_CHANENABLESTATEAptMessage_MGMSG_MOD_IDENTIFYAptMessage_MGMSG_MOD_REQ_CHANENABLESTATEAptMessage_MGMSG_MOD_SET_CHANENABLESTATEAptMessage_MGMSG_MOT_ACK_USTATUSUPDATEAptMessage_MGMSG_MOT_GET_HOMEPARAMSAptMessage_MGMSG_MOT_GET_JOGPARAMSAptMessage_MGMSG_MOT_GET_POSCOUNTERAptMessage_MGMSG_MOT_GET_STATUSUPDATEAptMessage_MGMSG_MOT_GET_STATUSUPDATE.chan_identAptMessage_MGMSG_MOT_GET_STATUSUPDATE.data_lengthAptMessage_MGMSG_MOT_GET_STATUSUPDATE.enc_countAptMessage_MGMSG_MOT_GET_STATUSUPDATE.from_bytes()AptMessage_MGMSG_MOT_GET_STATUSUPDATE.message_idAptMessage_MGMSG_MOT_GET_STATUSUPDATE.message_structAptMessage_MGMSG_MOT_GET_STATUSUPDATE.positionAptMessage_MGMSG_MOT_GET_STATUSUPDATE.statusAptMessage_MGMSG_MOT_GET_STATUSUPDATE.to_bytes()
AptMessage_MGMSG_MOT_GET_USTATUSUPDATEAptMessage_MGMSG_MOT_GET_VELPARAMSAptMessage_MGMSG_MOT_MOVE_ABSOLUTEAptMessage_MGMSG_MOT_MOVE_ABSOLUTE.absolute_distanceAptMessage_MGMSG_MOT_MOVE_ABSOLUTE.chan_identAptMessage_MGMSG_MOT_MOVE_ABSOLUTE.data_lengthAptMessage_MGMSG_MOT_MOVE_ABSOLUTE.from_bytes()AptMessage_MGMSG_MOT_MOVE_ABSOLUTE.message_idAptMessage_MGMSG_MOT_MOVE_ABSOLUTE.message_structAptMessage_MGMSG_MOT_MOVE_ABSOLUTE.to_bytes()
AptMessage_MGMSG_MOT_MOVE_COMPLETEDAptMessage_MGMSG_MOT_MOVE_COMPLETED_20_BYTESAptMessage_MGMSG_MOT_MOVE_COMPLETED_6_BYTESAptMessage_MGMSG_MOT_MOVE_HOMEAptMessage_MGMSG_MOT_MOVE_HOMEDAptMessage_MGMSG_MOT_MOVE_JOGAptMessage_MGMSG_MOT_MOVE_STOPAptMessage_MGMSG_MOT_MOVE_STOPPEDAptMessage_MGMSG_MOT_MOVE_STOPPED_20_BYTESAptMessage_MGMSG_MOT_MOVE_STOPPED_6_BYTESAptMessage_MGMSG_MOT_REQ_HOMEPARAMSAptMessage_MGMSG_MOT_REQ_JOGPARAMSAptMessage_MGMSG_MOT_REQ_POSCOUNTERAptMessage_MGMSG_MOT_REQ_STATUSUPDATEAptMessage_MGMSG_MOT_REQ_USTATUSUPDATEAptMessage_MGMSG_MOT_REQ_VELPARAMSAptMessage_MGMSG_MOT_RESUME_ENDOFMOVEMSGSAptMessage_MGMSG_MOT_SET_EEPROMPARAMSAptMessage_MGMSG_MOT_SET_EEPROMPARAMS.chan_identAptMessage_MGMSG_MOT_SET_EEPROMPARAMS.data_lengthAptMessage_MGMSG_MOT_SET_EEPROMPARAMS.from_bytes()AptMessage_MGMSG_MOT_SET_EEPROMPARAMS.message_idAptMessage_MGMSG_MOT_SET_EEPROMPARAMS.message_id_to_saveAptMessage_MGMSG_MOT_SET_EEPROMPARAMS.message_structAptMessage_MGMSG_MOT_SET_EEPROMPARAMS.to_bytes()
AptMessage_MGMSG_MOT_SET_HOMEPARAMSAptMessage_MGMSG_MOT_SET_JOGPARAMSAptMessage_MGMSG_MOT_SET_POSCOUNTERAptMessage_MGMSG_MOT_SET_VELPARAMSAptMessage_MGMSG_POL_GET_PARAMSAptMessage_MGMSG_POL_REQ_PARAMSAptMessage_MGMSG_POL_SET_PARAMSAptMessage_MGMSG_RESTOREFACTORYSETTINGSChanIdentEnableStateFirmwareVersionHardwareTypeHomeDirectionJogDirectionJogModeLimitSwitchStatusStatusBitsStopModeUStatusUStatus.ACTIVEUStatus.BUSCURRENTFAULTUStatus.BUSVOLTFAULTUStatus.CCWHARDLIMITUStatus.CCWSOFTLIMITUStatus.COMMUTATIONERRORUStatus.CONNECTEDUStatus.CWHARDLIMITUStatus.CWSOFTLIMITUStatus.DIGIP1UStatus.DIGIP2UStatus.DIGIP3UStatus.DIGIP4UStatus.ENABLEDUStatus.ENCODERFAULTUStatus.ERRORUStatus.HOMEDUStatus.HOMINGUStatus.INITILIZINGUStatus.INMOTIONCCWUStatus.INMOTIONCWUStatus.INSTRERRORUStatus.INTERLOCKUStatus.JOGGINGCCWUStatus.JOGGINGCWUStatus.OVERCURRENTUStatus.OVERLOADUStatus.OVERTEMPUStatus.POSITIONERRORUStatus.POWEROKUStatus.SETTLEDUStatus.TRACKINGUStatus.from_bits()UStatus.to_bits()
UStatusBitsUStatusBits.ACTIVEUStatusBits.BUSCURRENTFAULTUStatusBits.BUSVOLTFAULTUStatusBits.CCWHARDLIMITUStatusBits.CCWSOFTLIMITUStatusBits.COMMUTATIONERRORUStatusBits.CONNECTEDUStatusBits.CWHARDLIMITUStatusBits.CWSOFTLIMITUStatusBits.DIGIP1UStatusBits.DIGIP2UStatusBits.DIGIP3UStatusBits.DIGIP4UStatusBits.ENABLEDUStatusBits.ENCODERFAULTUStatusBits.ERRORUStatusBits.HOMEDUStatusBits.HOMINGUStatusBits.INITILIZINGUStatusBits.INMOTIONCCWUStatusBits.INMOTIONCWUStatusBits.INSTRERRORUStatusBits.INTERLOCKUStatusBits.JOGGINGCCWUStatusBits.JOGGINGCWUStatusBits.OVERCURRENTUStatusBits.OVERLOADUStatusBits.OVERTEMPUStatusBits.POSITIONERRORUStatusBits.POWEROKUStatusBits.SETTLEDUStatusBits.TRACKING