nodewatcher Terminology

This page is for future nodewatcher version currently in development.

We use many different terms in our nodewatcher platform and this page is meant to provide a reference for all their meanings.

nodewatcher module

Modules are standard Django applications that use the common nodewatcher APIs (such as the registry framework).

CGM

Stands for Configuration Generating Module(s) and is an integral part of the new firmware image generator framework. These modules are responsible for generating per-platform (for example UCI in case of OpenWrt) configuration from the more abstract configuration provided by the node configuration registry. CGMs are actually callable Python objects (such as functions) that can be registered by any nodewatcher module. Registry items that contain CGM configuration often have the Cgm prefix.

Registry Terminology

registry anchor

TODO

hidden registry anchor

TODO

polymorphic

TODO

Registry Types

Exotic registry type explanations:

geospatial

Properly indexed geographical coordinates.

registered choice

Choices (enums) can be registered by nodewatcher modules for each identifier (for example choices core.general#platform are registered by CGMs implementing support for different platforms and such choices automatically become available to all models). May depend on values of other fields.

mac string

A string representing a MAC address in the form \d\d:\d\d:\d\d:\d\d:\d\d:\d\d.

bssid string

A string representing WiFi BSSID in the form \d\d:\d\d:\d\d:\d\d:\d\d:\d\d.

hardware address string

A string representing normalized general hardware address (for example, a MAC address).

ip address

An IPv4 or IPv6 address with optional subnet specification in CIDR notation.

client id

A value uniquely representing client. For example, a salt-hashed client's MAC address.

foreign key

Foreign key to some non-registry item model. Also see the auxilary models sections on registration point description pages.

intra-registry foreign key

A foreign key that defines a parent-child relationship between two registry ids.

radiation pattern

Contains antenna's 3D radiation pattern.