Welcome to pyGuardPoint’s documentation!
pyGuardPoint is a Python wrapper for the GuardPoint 10 API, which allows developers to easily integrate with the GuardPoint 10 physical access control system (ACS). Find out more about Sensor Access’s GuardPoint Access Control Server here Sensor Access and offers a simple and intuitive API.
Check out the Usage section for further information, including how to Installation the project.
Note
This project is under active development.
Contents
- Usage
- Snippets
- API
GuardPointGuardPoint.__init__()GuardPoint.get_cardholder_count()GuardPoint.get_signal_client()GuardPoint.start_listening()GuardPoint.stop_listening()GuardPoint.activate_manual_event()GuardPoint.activate_manual_event_by_api_key()GuardPoint.activate_relay()GuardPoint.activate_relay_by_uid()GuardPoint.add_scheduled_mag()GuardPoint.arm_alarm_zone()GuardPoint.delete_card()GuardPoint.delete_card_holder()GuardPoint.disarm_alarm_zone()GuardPoint.get_access_events()GuardPoint.get_access_events_count()GuardPoint.get_access_groups()GuardPoint.get_alarm_events()GuardPoint.get_alarm_events_count()GuardPoint.get_alarm_state()GuardPoint.get_alarm_states()GuardPoint.get_alarm_zone()GuardPoint.get_alarm_zones()GuardPoint.get_areas()GuardPoint.get_audit_events()GuardPoint.get_audit_events_count()GuardPoint.get_card()GuardPoint.get_card_holder()GuardPoint.get_card_holder_photo()GuardPoint.get_card_holders()GuardPoint.get_cardholder_by_card_code()GuardPoint.get_cardholder_types()GuardPoint.get_cards()GuardPoint.get_controller()GuardPoint.get_controllers()GuardPoint.get_custom_fields()GuardPoint.get_department()GuardPoint.get_departments()GuardPoint.get_info()GuardPoint.get_infos()GuardPoint.get_input()GuardPoint.get_inputs()GuardPoint.get_manual_events()GuardPoint.get_reader()GuardPoint.get_readers()GuardPoint.get_relay()GuardPoint.get_relays()GuardPoint.get_scheduled_mags()GuardPoint.get_security_groups()GuardPoint.get_site()GuardPoint.get_sites()GuardPoint.get_ssl_context()GuardPoint.get_token()GuardPoint.get_weekly_program()GuardPoint.get_weekly_programs()GuardPoint.gp_version()GuardPoint.is_sigr_enabled()GuardPoint.new_card()GuardPoint.new_card_holder()GuardPoint.renew_token()GuardPoint.set_token()GuardPoint.simulate_access_event()GuardPoint.update_card()GuardPoint.update_card_holder()GuardPoint.update_card_holder_area()GuardPoint.update_custom_fields()GuardPoint.update_personal_details()
CardholderCardholder.uidCardholder.lastNameCardholder.firstNameCardholder.cardholderIdNumberCardholder.statusCardholder.fromDateValidCardholder.isFromDateActiveCardholder.toDateValidCardholder.isToDateActiveCardholder.photoCardholder.ownerSiteUIDCardholder.securityGroupApiKeyCardholder.ownerSiteApiKeyCardholder.accessGroupApiKeysCardholder.liftAccessGroupApiKeysCardholder.cardholderTypeUIDCardholder.departmentUIDCardholder.descriptionCardholder.grantAccessForSupervisorCardholder.isSupervisorCardholder.needEscortCardholder.personalWeeklyProgramUIDCardholder.pinCodeCardholder.sharedStatusCardholder.securityGroupUIDCardholder.accessGroupUIDsCardholder.liftAccessGroupUIDsCardholder.personalCrisisLevelCardholder.lastDownloadTimeCardholder.lastInOutAreaCardholder.lastInOutReaderUIDCardholder.lastInOutDateCardholder.lastAreaReaderDateCardholder.lastAreaReaderUIDCardholder.lastPassDateCardholder.lastReaderPassUIDCardholder.insideAreaUIDCardholder.cardsCardholder.noAntiPassbackCardholder.insideAreaCardholder.securityGroupCardholder.cardholderTypeCardholder.cardholderPersonalDetailCardholder.cardholderCustomizedFieldCardholder.to_search_pattern()Cardholder.pretty_print()Cardholder.dict()
CardAreaSecurityGroupCardholderPersonalDetailCardholderPersonalDetail.uidCardholderPersonalDetail.officePhoneCardholderPersonalDetail.cityOrDistrictCardholderPersonalDetail.streetOrApartmentCardholderPersonalDetail.postCodeCardholderPersonalDetail.privatePhoneOrFaxCardholderPersonalDetail.mobileCardholderPersonalDetail.emailCardholderPersonalDetail.carRegistrationNumCardholderPersonalDetail.companyCardholderPersonalDetail.idFreeTextCardholderPersonalDetail.idTypeCardholderPersonalDetail.dict()
CardholderCustomizedFieldCardholderCustomizedField.uidCardholderCustomizedField.cF_BoolField_1CardholderCustomizedField.cF_BoolField_2CardholderCustomizedField.cF_BoolField_3CardholderCustomizedField.cF_BoolField_4CardholderCustomizedField.cF_BoolField_5CardholderCustomizedField.cF_IntField_1CardholderCustomizedField.cF_IntField_2CardholderCustomizedField.cF_IntField_3CardholderCustomizedField.cF_IntField_4CardholderCustomizedField.cF_IntField_5CardholderCustomizedField.cF_DateTimeField_1CardholderCustomizedField.cF_DateTimeField_2CardholderCustomizedField.cF_DateTimeField_3CardholderCustomizedField.cF_DateTimeField_4CardholderCustomizedField.cF_DateTimeField_5CardholderCustomizedField.cF_StringField_1CardholderCustomizedField.cF_StringField_2CardholderCustomizedField.cF_StringField_3CardholderCustomizedField.cF_StringField_4CardholderCustomizedField.cF_StringField_5CardholderCustomizedField.cF_StringField_6CardholderCustomizedField.cF_StringField_7CardholderCustomizedField.cF_StringField_8CardholderCustomizedField.cF_StringField_9CardholderCustomizedField.cF_StringField_10CardholderCustomizedField.cF_StringField_11CardholderCustomizedField.cF_StringField_12CardholderCustomizedField.cF_StringField_13CardholderCustomizedField.cF_StringField_14CardholderCustomizedField.cF_StringField_15CardholderCustomizedField.cF_StringField_16CardholderCustomizedField.cF_StringField_17CardholderCustomizedField.cF_StringField_18CardholderCustomizedField.cF_StringField_19CardholderCustomizedField.cF_StringField_20CardholderCustomizedField.dict()
CardholderTypeAccessEventAccessEvent.accessDeniedCodeAccessEvent.cardCodeAccessEvent.cardholderFirstNameAccessEvent.cardholderIdNumberAccessEvent.cardholderLastNameAccessEvent.cardholderTypeNameAccessEvent.cardholderTypeUIDAccessEvent.cardholderUIDAccessEvent.carRegistrationNumAccessEvent.dateTimeAccessEvent.escortCardCodeAccessEvent.escortFirstNameAccessEvent.escortLastNameAccessEvent.escortUIDAccessEvent.inOutTypeAccessEvent.isEscortAccessEvent.isPastEventAccessEvent.isSlaveAccessEvent.journalUpdateDateTimeAccessEvent.logIDAccessEvent.readerFunctionCodesAccessEvent.readerNameAccessEvent.readerUIDAccessEvent.transactionCodeAccessEvent.typeAccessEvent.uidAccessEvent.ownerSiteUIDAccessEvent.additionalSitesAccessEvent.ownerSiteNameAccessEvent.additionalSitesNamesAccessEvent.additionalInfoAccessEvent.dict()
AlarmEventAlarmEvent.additionalSitesAlarmEvent.additionalSitesNamesAlarmEvent.alarmUIDAlarmEvent.confirmationCommentsAlarmEvent.dateTimeAlarmEvent.inputNameAlarmEvent.inputUIDAlarmEvent.isAcknowledgedAlarmEvent.isConfirmedAlarmEvent.isPastEventAlarmEvent.journalUpdateDateTimeAlarmEvent.ownerSiteNameAlarmEvent.ownerSiteUIDAlarmEvent.typeAlarmEvent.uidAlarmEvent.userFirstNameAlarmEvent.userLastNameAlarmEvent.userNameAlarmEvent.userUIDAlarmEvent.dict()
RelayControllerController.isActivatedController.uidController.addressController.networkUIDController.nameController.isPoolingController.statusController.purposeController.isConnectedController.disconnectTimeController.descriptionController.scriptController.firmwareVersionController.hardwareVersionController.apiKeyController.dict()
ReaderReader.uidReader.nameReader.descriptionReader.numberReader.controllerUIDReader.firstOutputUIDReader.secondOutputUIDReader.weeklyProgramUIDReader.readerFunctionIDsReader.apiKeyReader.doorAlarmInputUIDReader.doorControlInput1UIDReader.doorControlInput2UIDReader.doorRemoteInputUIDReader.motorizedReaderInputUIDReader.dict()
ScheduledMag
- Asyncio
- Signal-R