edc-device

edc-device provides device roles unique device IDs for hosts and clients where the hostname may not be reliable. Hosts can be group as servers, clients, node_servers and some of their functionality limited according to this role.

A unique device ID is used to seed unique subject and sample identifiers. Uniqueness is evaluated during deployment.

Device information is set in and read from edc_device.apps.AppConfig.

You should subclass into your projects apps.py like this, for example:

from edc_device.apps import AppConfig as EdcDeviceAppConfigParent

class EdcDeviceAppConfig(EdcDeviceAppConfigParent):
    device_id = '32'
    device_role = CLIENT
    device_permissions = DevicePermissions(
        plot_add, plot_change, ...)

and then in your settings:

INSTALLED_APPS = [
    ...
    my_app.apps.EdcDeviceAppConfig,
    myapp.apps.AppConfig',
]

Include in your urls.py:

urlpatterns = [
    ...
    path('edc_device/', include('edc_device.urls')),
    ...
]

To get to the Edc Device home page, reverse the url like this:

reverse('edc_device:home_url')

Usage

A client might look like this:

class EdcDeviceAppConfig(EdcDeviceAppConfigParent):
    device_id = '18'
    node_server_id_list = [97, 98, 99]
    middleman_id_list = [95, 96]

>>> from django.apps import apps as django_apps
>>> app_config = django_apps.get_app_config('edc_device')
>>> app_config.device_id
'18'
>>> app_config.is_client
True
>>> app_config.device_role
'Client'

A node server server might look like this:

class EdcDeviceAppConfig(EdcDeviceAppConfigParent):
    device_id = '98'
    node_server_id_list = [97, 98, 99]
    middleman_id_list = [95, 96]

>>> from django.apps import apps as django_apps
>>> app_config = django_apps.get_app_config('edc_device')
>>> app_config.device_id
'98'
>>> app_config.is_node_server
True
>>> app_config.device_role
'NodeServer'

A middleman server might look like this:

class EdcDeviceAppConfig(EdcDeviceAppConfigParent):
    device_id = '95'
    node_server_id_list = [97, 98, 99]
    middleman_id_list = [95, 96]

>>> from django.apps import apps as django_apps
>>> app_config = django_apps.get_app_config('edc_device')
>>> app_config.device_id
'95'
>>> app_config.is_middleman
True
>>> app_config.device_role
'Middleman'

The central server might look like this:

class EdcDeviceAppConfig(EdcDeviceAppConfigParent):
    device_id = '99'
    node_server_id_list = [97, 98, 99]
    middleman_id_list = [95, 96]

>>> from django.apps import apps as django_apps
>>> app_config = django_apps.get_app_config('edc_device')
>>> app_config.device_id
'99'
>>> app_config.is_middleman
True
>>> app_config.device_role
'CentralServer'

Device Permissions by Model

You can use the device role, or the device ID, to limit ADD/CHANGE permissions on a model.

edc-device AppConfig maintains a collection of DeviceAddPermission and DeviceChangePermission instances that are inspected in the save method of a model using the DeviceModelMixin.

To declare a DeviceAddPermission object:

test_model_add = DeviceAddPermission(
    model='my_app.mymodel, device_roles=[NODE_SERVER, CENTRAL_SERVER])

To declare a DeviceChangePermission object:

test_model_change = DeviceChangePermission(
    model='my_app.mymodel, device_roles=[CLIENT])

This means that if app_config.device_role is anything other than NODE_SERVER or CENTRAL_SERVER, the save method will raise a DevicePermissionsAddError.

To register the instances with edc_device.apps.AppConfig.device_permissions:

device_permissions = DevicePermissions(test_model_add, test_model_change)

This means that if app_config.device_role is anything other than CLIENT, the save method will raise a DevicePermissionsChangeError.

On boot up you should see:

Loading Edc Device ...
  * device id is '10'.
  * device role is 'Client'.
  * device permissions exist for:
    - edc_device.testmodel ADD NodeServer,CentralServer
    - edc_device.testmodel CHANGE Client
Done loading Edc Device.

Models declared with the EdcDeviceModelMixin check the device permissions collection on save. Note the model mixin is already declared with BaseUuidModel.

from edc_model.models import BaseUuidModel

class TestModel(BaseUuidModel):
    pass

Declaring device permissions directly on model Meta class:

You can declare device permissions on Meta.device_permissions in the same way as above.

[...]
class Meta(DeviceModelMixin.Meta):
    device_permissions = DevicePermissions(...)

Both Meta and AppConfig device permissions will be called, where the Meta class object will be called first.

Disable device permissions by model instance:

You can disable device permissions per model instance by setting check_device_permissions to False

Customizing Device Permissions

The ADD and CHANGE device permission objects by default inspect the model’s id. If obj.id is None, it as an ADD model operation; If obj.id is not None, it is a CHANGE model operation.

You can change this by overriding the model_operation method. The model_operation must return None or some value, such as self.label.

For example:

# default for DeviceAddPermission
label = 'ADD'

def model_operation(self, model_obj=None, **kwargs):
    if not model_obj.id:
        return self.label
    return None

# overridden
def model_operation(self, model_obj=None, **kwargs):
    """Return ADD if both id and plot identifier are None.
    """
    if not model_obj.id and not obj.plot_identifier:
        return self.label
    return None

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

edc_device-1.0.1.tar.gz (28.9 kB view details)

Uploaded Jun 26, 2025 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

edc_device-1.0.1-py3-none-any.whl (29.1 kB view details)

Uploaded Jun 26, 2025 Python 3

File details

Details for the file edc_device-1.0.1.tar.gz.

File metadata

Download URL: edc_device-1.0.1.tar.gz
Upload date: Jun 26, 2025
Size: 28.9 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/6.1.0 CPython/3.12.11

File hashes

Hashes for edc_device-1.0.1.tar.gz
Algorithm	Hash digest
SHA256	`2b34f770b9a04bdc8457e95ae3bbd3867fc004cd8b3293a84b276656b75c49ce`
MD5	`554cf30db72b84357b208f38f6a26fbd`
BLAKE2b-256	`00dfaffaef09f9c28f69f0bdbd5a79b86448be5445ce6264ca812c8c8be0273b`

See more details on using hashes here.

File details

Details for the file edc_device-1.0.1-py3-none-any.whl.

File metadata

Download URL: edc_device-1.0.1-py3-none-any.whl
Upload date: Jun 26, 2025
Size: 29.1 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/6.1.0 CPython/3.12.11

File hashes

Hashes for edc_device-1.0.1-py3-none-any.whl
Algorithm	Hash digest
SHA256	`17147ce18ecdbf9345221a1c4496a455fe472150bed91315743226b8f5ad812b`
MD5	`744dfa043fa61827ce427aea91880bda`
BLAKE2b-256	`1ff8f5147eec146f93cfa223162fe5762b2a283bb7992755368aca4543f37ea7`