Made key and name attributes optional in register-group-instance TDF elements

Also removed the attribute from all instances of the element, where it wasn't necessary.

build/scripts/Targets/TargetDescriptionFiles/Services/ValidationService.php

@@ -166,18 +166,9 @@ class ValidationService
 
         if (empty($propertyGroup->key)) {
             $failures[] = 'Missing key';
-        }
 
-        if (!mb_check_encoding((string) $propertyGroup->key, 'ASCII')) {
-            $failures[] = 'Key contains non ASCII characters';
-        }
-
-        if (str_contains((string) $propertyGroup->key, ' ')) {
-            $failures[] = 'Key contains at least one white character';
-        }
-
-        if (str_contains((string) $propertyGroup->key, '.')) {
-            $failures[] = 'Key contains at least one period (".") character';
+        } else {
+            $failures = array_merge($failures, $this->validateKey($propertyGroup->key));
         }
 
         if (empty($propertyGroup->subPropertyGroups) && empty($propertyGroup->properties)) {
@@ -219,18 +210,9 @@ class ValidationService
 
         if (empty($property->key)) {
             $failures[] = 'Missing key';
-        }
 
-        if (!mb_check_encoding((string) $property->key, 'ASCII')) {
-            $failures[] = 'Key contains non ASCII characters';
-        }
-
-        if (str_contains((string) $property->key, ' ')) {
-            $failures[] = 'Key contains at least white space character';
-        }
-
-        if (str_contains((string) $property->key, '.')) {
-            $failures[] = 'Key contains at least one period (".") character';
+        } else {
+            $failures = array_merge($failures, $this->validateKey($property->key));
         }
 
         if ($property->value === null) {
@@ -312,14 +294,9 @@ class ValidationService
 
         if (empty($segment->key)) {
             $failures[] = 'Missing key';
-        }
 
-        if (!preg_match('/^[a-z_]+$/',$segment->key)) {
-            $failures[] = 'Key must contain only lowercase letters';
-        }
-
-        if (!mb_check_encoding((string) $segment->key, 'ASCII')) {
-            $failures[] = 'Key must contain only ASCII characters';
+        } else {
+            $failures = array_merge($failures, $this->validateKey($segment->key));
         }
 
         if (empty($segment->name)) {
@@ -445,18 +422,9 @@ class ValidationService
 
         if (empty($registerGroup->key)) {
             $failures[] = 'Missing key';
-        }
 
-        if (!mb_check_encoding((string) $registerGroup->key, 'ASCII')) {
-            $failures[] = 'Key contains non ASCII characters';
-        }
-
-        if (str_contains((string) $registerGroup->key, ' ')) {
-            $failures[] = 'Key contains at least one white character';
-        }
-
-        if (str_contains((string) $registerGroup->key, '.')) {
-            $failures[] = 'Key contains at least one period (".") character';
+        } else {
+            $failures = array_merge($failures, $this->validateKey($registerGroup->key));
         }
 
         if (empty($registerGroup->name)) {
@@ -534,18 +502,9 @@ class ValidationService
 
         if (empty($registerGroupReference->key)) {
             $failures[] = 'Missing key';
-        }
 
-        if (!mb_check_encoding((string) $registerGroupReference->key, 'ASCII')) {
-            $failures[] = 'Key contains non ASCII characters';
-        }
-
-        if (str_contains((string) $registerGroupReference->key, ' ')) {
-            $failures[] = 'Key contains at least one period space';
-        }
-
-        if (str_contains((string) $registerGroupReference->key, '.')) {
-            $failures[] = 'Key contains at least one period (".") character';
+        } else {
+            $failures = array_merge($failures, $this->validateKey($registerGroupReference->key));
         }
 
         if (empty($registerGroupReference->registerGroupKey)) {
@@ -581,18 +540,9 @@ class ValidationService
 
         if (empty($register->key)) {
             $failures[] = 'Missing key';
-        }
 
-        if (!mb_check_encoding((string) $register->key, 'ASCII')) {
-            $failures[] = 'Key contains non ASCII character';
-        }
-
-        if (str_contains((string) $register->key, ' ')) {
-            $failures[] = 'Key contains at least white space character';
-        }
-
-        if (str_contains((string) $register->key, '.')) {
-            $failures[] = 'Key contains at least one period (".") character';
+        } else {
+            $failures = array_merge($failures, $this->validateKey($register->key));
         }
 
         if (empty($register->name)) {
@@ -750,30 +700,14 @@ class ValidationService
     ): array {
         $failures = [];
 
-        if (empty($registerGroupInstance->key)) {
-            $failures[] = 'Missing key';
-        }
-
-        if (!mb_check_encoding((string) $registerGroupInstance->key, 'ASCII')) {
-            $failures[] = 'Key contains non ASCII characters';
-        }
-
-        if (str_contains((string) $registerGroupInstance->key, ' ')) {
-            $failures[] = 'Key contains at least one period space';
-        }
-
-        if (str_contains((string) $registerGroupInstance->key, '.')) {
-            $failures[] = 'Key contains at least one period (".") character';
+        if (!empty($registerGroupInstance->key)) {
+            $failures = array_merge($failures, $this->validateKey($registerGroupInstance->key));
         }
 
         if (empty($registerGroupInstance->registerGroupKey)) {
             $failures[] = 'Missing register group key';
         }
 
-        if (empty($registerGroupInstance->name)) {
-            $failures[] = 'Missing name';
-        }
-
         if ($registerGroupInstance->offset === null) {
             $failures[] = 'Missing offset';
 
@@ -978,4 +912,31 @@ class ValidationService
             $failures
         );
     }
+
+    protected function validateKey(string $key): array
+    {
+        $failures = [];
+
+        if (!mb_check_encoding($key, 'ASCII')) {
+            $failures[] = 'Key contains non ASCII characters';
+        }
+
+        if (strtolower($key) !== $key) {
+            $failures[] = 'Key must contain only lowercase characters';
+        }
+
+        if (str_contains($key, ' ')) {
+            $failures[] = 'Key contains at least one whitespace';
+        }
+
+        if (str_contains($key, '.')) {
+            $failures[] = 'Key contains at least one period (".") character';
+        }
+
+        return array_map(
+            fn (string $failure): string => 'Key validation failure for key "' . $key
+                . '": ' . $failure,
+            $failures
+        );
+    }
 }

build/scripts/Targets/TargetDescriptionFiles/Services/Xml/ToXmlService.php

@@ -162,8 +162,14 @@ class ToXmlService
         DOMDocument $document
     ): DOMElement {
         $element = $document->createElement('register-group-instance');
-        $element->setAttribute('key', $registerGroupInstance->key);
-        $element->setAttribute('name', $registerGroupInstance->name);
+
+        if (!empty($registerGroupInstance->key)) {
+            $element->setAttribute('key', $registerGroupInstance->key);
+        }
+
+        if (!empty($registerGroupInstance->name)) {
+            $element->setAttribute('name', $registerGroupInstance->name);
+        }
 
         if (!empty($registerGroupInstance->description)) {
             $element->setAttribute('description', $registerGroupInstance->description);

build/scripts/Targets/TargetDescriptionFiles/TargetDescriptionFile.php

@@ -317,12 +317,12 @@ class TargetDescriptionFile
             $registerGroup = $this->resolveRegisterGroupInstance($registerGroupInstance, $peripheral->moduleKey);
             if ($registerGroup instanceof RegisterGroup) {
                 $output->registerGroups[] = $this->targetRegisterGroupFromRegisterGroup(
-                    $registerGroupInstance->key,
-                    $registerGroupInstance->name,
                     $registerGroupInstance->addressSpaceKey,
                     $registerGroup,
                     $registerGroupInstance->offset ?? 0,
-                    $peripheral->moduleKey
+                    $peripheral->moduleKey,
+                    $registerGroupInstance->key,
+                    $registerGroupInstance->name
                 );
             }
         }
@@ -331,20 +331,25 @@ class TargetDescriptionFile
     }
 
     private function targetRegisterGroupFromRegisterGroup(
-        string $key,
-        string $name,
         string $addressSpaceKey,
         RegisterGroup $registerGroup,
         int $addressOffset,
-        string $moduleKey
+        string $moduleKey,
+        ?string $keyOverride = null,
+        ?string $nameOverride = null
     ): TargetRegisterGroup {
         $addressOffset += $registerGroup->offset ?? 0;
-        $output = new TargetRegisterGroup($key, $name, $addressSpaceKey, $addressOffset, [], []);
+        $output = new TargetRegisterGroup(
+            $keyOverride ?? $registerGroup->key,
+            $nameOverride ?? $registerGroup->name,
+            $addressSpaceKey,
+            $addressOffset,
+            [],
+            []
+        );
 
         foreach ($registerGroup->subgroups as $subgroup) {
             $output->subgroups[] = $this->targetRegisterGroupFromRegisterGroup(
-                $subgroup->key,
-                $subgroup->name,
                 $addressSpaceKey,
                 $subgroup,
                 $addressOffset,
@@ -357,12 +362,12 @@ class TargetDescriptionFile
 
             if ($subgroup instanceof RegisterGroup) {
                 $output->subgroups[] = $this->targetRegisterGroupFromRegisterGroup(
-                    $subgroupReference->key,
-                    $subgroupReference->name,
                     $addressSpaceKey,
                     $subgroup,
                     $addressOffset + $subgroupReference->offset,
-                    $moduleKey
+                    $moduleKey,
+                    $subgroupReference->key,
+                    $subgroupReference->name
                 );
             }
         }