devices.models

This modules contains all models specific to the device abstractions.

Module Contents

class devices.models.DeviceModel(*args, **kwargs)[source]

Bases: util.db.CustomDeleteActionModel

The DeviceModel.

common_name[source]
serial_number[source]
ip_address[source]
opc_server_port[source]
domain[source]
onboarding_config[source]
no_onboarding_config[source]
class DeviceType(*args, **kwds)[source]

Bases: django.db.models.IntegerChoices

Enum for device type.

GENERIC_DEVICE[source]
OPC_UA_GDS[source]
OPC_UA_GDS_PUSH[source]
device_type[source]
created_at[source]
opc_gds_push_enable_periodic_update[source]
opc_gds_push_renewal_interval[source]
opc_gds_push_last_update_scheduled_at[source]
pre_delete()[source]

Delete all issued credentials for this device before deleting the device itself.

Return type:

None

property est_username: str[source]

Gets the EST username.

Return type:

str

clean()[source]

Validation before saving the model.

Return type:

None

schedule_next_gds_push_update()[source]

Schedule the next periodic GDS Push server certificate and trustlist update using Django-Q2.

Creates a one-off scheduled task in Django-Q2 that will execute at the calculated time based on the configured renewal interval. Does nothing when periodic updates are disabled or the device is not of type OPC UA GDS Push.

Return type:

None

class devices.models.RemoteDeviceCredentialDownloadModel(*args, **kwargs)[source]

Bases: django.db.models.Model

Model to associate a credential model with an OTP and token for unauthenticated remoted download.

BROWSER_MAX_OTP_ATTEMPTS = 3[source]
TOKEN_VALIDITY[source]
issued_credential_model[source]
otp[source]
device[source]
attempts[source]
download_token[source]
token_created_at[source]
class Meta[source]

Bases: django_stubs_ext.db.models.TypedModelMeta

Meta class configuration.

save(*args, **kwargs)[source]

Generates a new random OTP on initial save of the model.

Parameters:

  • args (Any)

  • kwargs (Any)

Return type:

None

get_otp_display()[source]

Return the OTP in the format ‘credential_id.otp’ for display within the admin view.

Returns:

The str to display.

Return type:

str

check_otp(otp)[source]

Check if the provided OTP matches the stored OTP.

Parameters:

otp (str) – The OTP to check.

Returns:

True if the OTP is valid, False otherwise.

Return type:

bool

check_token(token)[source]

Check if the provided token matches the stored token and whether it is still valid.

Parameters:

token (str) – The token to check.

Returns:

True if the token is valid, false otherwise.

Return type:

bool