Associate MAC settings profile

[halimi]

Summary

References: #7380

Changes

• Associate MAC settings profile to an end device
• Validate the associated MAC settings profile according to the end device's FrequencyPlan and Band
• Use the profile settings during uplink and downlink messages

Testing

Steps

The best way to test this to use a real end device.

Prerequisite:

• Create an application and end device
• Connect a gateway and the end device to the TTS

Test steps:

• Create a MAC settings profile
• Assign the profile to the end device
• Send uplinks and downlinks and verify everything works

Negative tests:

• Assign a mac settings profile and device mac settings at the same time -> it should fail, they are mutually exclusive
• Assign a mac settings profile that contains invalid settings for the end device -> validation should fail

Results

Create a MAC settings profile

POST http://localhost:1885/api/v3/ns/applications/myapp/mac_settings_profiles

{
  "mac_settings_profile": {
    "ids": {
      "application_ids": {
        "application_id": "myapp"
      },
      "profile_id": "mac1"
    },
    "mac_settings": {
      "rx2_data_rate_index": 0,
      "rx2_frequency": "869525000"
    }
  }
}

Assign the profile to the end device

PUT http://localhost:1885/api/v3/ns/applications/myapp/devices/arduino-mkr

{
  "end_device": {
    "ids": {
      "device_id": "arduino-mkr",
      "application_ids": {
        "application_id": "myapp"
      }
    },
    "lorawan_version": "MAC_V1_0_3",
    "lorawan_phy_version": "PHY_V1_0_3_REV_A",
    "frequency_plan_id": "EU_863_870_TTN",
    "supports_join": true,
    "mac_settings_profile_ids": {
      "application_ids": {
        "application_id": "myapp"
      },
      "profile_id": "mac1"
    }
  },
  "field_mask": {
    "paths": [
      "supports_join",
      "lorawan_version",
      "lorawan_phy_version",
      "ids.device_id",
      "ids.application_ids.application_id",
      "mac_settings_profile_ids"
    ]
  }
}

Assign a mac settings profile and device mac settings at the same time -> it should fail, they are mutually exclusive

PUT http://localhost:1885/api/v3/ns/applications/myapp/devices/arduino-mkr

{
  "end_device": {
    "ids": {
      "device_id": "arduino-mkr",
      "application_ids": {
        "application_id": "myapp"
      }
    },
    "lorawan_version": "MAC_V1_0_3",
    "lorawan_phy_version": "PHY_V1_0_3_REV_A",
    "frequency_plan_id": "EU_863_870_TTN",
    "supports_join": true,
    "mac_settings": {
      "rx1_delay": 5,
      "rx2_data_rate_index": 0,
      "rx2_frequency": "869525000",
      "supports_32_bit_f_cnt": true
    },
    "mac_settings_profile_ids": {
      "application_ids": {
        "application_id": "myapp"
      },
      "profile_id": "mac1"
    }
  },
  "field_mask": {
    "paths": [
      "supports_join",
      "lorawan_version",
      "lorawan_phy_version",
      "ids.device_id",
      "ids.application_ids.application_id",
      "mac_settings_profile_ids",
      "mac_settings.rx1_delay",
      "mac_settings.rx2_data_rate_index",
      "mac_settings.rx2_frequency",
      "mac_settings.supports_32_bit_f_cnt"
    ]
  }
}

Assign a mac settings profile that contains invalid settings for the end device -> validation should fail

PUT http://localhost:1885/api/v3/ns/applications/myapp/mac_settings_profiles/mac1

{
  "mac_settings_profile": {
    "ids": {
      "application_ids": {
        "application_id": "myapp"
      },
      "profile_id": "mac1"
    },
    "mac_settings": {
      "rx1_delay": 5,
      "rx2_data_rate_index": 0,
      "rx2_frequency": "869525000",
      "supports_32_bit_f_cnt": true,
      "uplink_dwell_time": true
    }
  },
  "field_mask": {
    "paths": [
      "mac_settings.rx1_delay",
      "mac_settings.rx2_data_rate_index",
      "mac_settings.rx2_frequency",
      "mac_settings.supports_32_bit_f_cnt",
      "mac_settings.uplink_dwell_time"
    ]
  }
}

PUT http://localhost:1885/api/v3/ns/applications/myapp/devices/arduino-mkr

{
  "end_device": {
    "ids": {
      "device_id": "arduino-mkr",
      "application_ids": {
        "application_id": "myapp"
      }
    },
    "lorawan_version": "MAC_V1_0_3",
    "lorawan_phy_version": "PHY_V1_0_3_REV_A",
    "frequency_plan_id": "EU_863_870_TTN",
    "supports_join": true,
    "mac_settings_profile_ids": {
      "application_ids": {
        "application_id": "myapp"
      },
      "profile_id": "mac1"
    }
  },
  "field_mask": {
    "paths": [
      "supports_join",
      "lorawan_version",
      "lorawan_phy_version",
      "ids.device_id",
      "ids.application_ids.application_id",
      "mac_settings_profile_ids"
    ]
  }
}

Regressions

...

Notes for Reviewers

...

Checklist

• Scope: The referenced issue is addressed, there are no unrelated changes.
• Compatibility: The changes are backwards compatible with existing API, storage, configuration and CLI, according to the compatibility commitments in README.md for the chosen target branch.
• Documentation: Relevant documentation is added or updated.
• Testing: The steps/process to test this feature are clearly explained including testing for regressions.
• Infrastructure: If infrastructural changes (e.g., new RPC, configuration) are needed, a separate issue is created in the infrastructural repositories.
• Changelog: Significant features, behavior changes, deprecations and fixes are added to CHANGELOG.md.
• Commits: Commit messages follow guidelines in CONTRIBUTING.md, there are no fixup commits left.

[johanstokking]

Great stuff