Add material certifications

BFW-8077

Author: CZDanol

data/main_fields.yaml

@@ -244,6 +244,13 @@
   required: recommended
   description: Properties of the material. Can have multiple tags at once.
 
+- key: 56
+  name: certifications
+  type: enum_array
+  items_file: material_certifications_enum.yaml
+  example: "`ul_2818`"
+  description: Certifications the material has.
+
 - key: 29
   name: density
   type: number

data/material_certifications_enum.yaml

@@ -0,0 +1,12 @@
+- key: 0
+  name: ul_2818
+  display_name: UL 2818
+  description:
+    - GREENGUARD Certification Program For Chemical Emissions For Building Materials, Finishes And Furnishings.
+
+- key: 1
+  name: ul_94_v0
+  display_name: UL 94 V0
+  description:
+    - Standard for Safety of Flammability of Plastic Materials for Parts in Devices and Appliances testing.
+    - Indicates a flame-retardant material.

docs_src/_sidebar.md

@@ -3,6 +3,7 @@
 - [Data format](/nfc_data_format)
 - [Material types](/material_types)
 - [Material tags](/material_tags)
+- [Material certifications](/material_certifications)
 - [Technical details](/nfc_technical_details)
 - [Examples](/examples)
 - [Contributing](/contributing)

docs_src/generate.py

@@ -73,6 +73,13 @@ def gen_material_tag_table():
     Column(field="description", title="Description"),
 ]
 
+env.globals["material_certification_columns"] = [
+    Column(field="key", title="Key"),
+    Column(field="name", title="Name", transform=lambda x: f"`{x}`"),
+    Column(field="display_name", title="Display name"),
+    Column(field="description", title="Description"),
+]
+
 gen_doc_file("_navbar")
 gen_doc_file("_sidebar")
 gen_doc_file("README")
@@ -82,7 +89,8 @@ def gen_material_tag_table():
 gen_doc_file("nfc_technical_details")
 gen_doc_file("examples")
 gen_doc_file("contributing")
-gen_doc_file("material_tags")
 gen_doc_file("material_types")
+gen_doc_file("material_tags")
+gen_doc_file("material_certifications")
 
 shutil.copyfile(f"{dir}/class_diagram.svg", f"{out_dir}/class_diagram.svg")

docs_src/material_certifications.md

@@ -0,0 +1,6 @@
+# Material certifications
+Material certifications allow expressing what certificates a material has.
+
+The certifications are stored as an enum on the tag to reduce memory usage and promote standard encoding. If there is a certification missing in the enum, please create a PR or file an issue in the [OpenPrintTag repository]({{repo}}).
+
+{{ enum_table("material_certifications_enum", material_certification_columns) }}

tests/encode_decode/01_data.bin

@@ -8,7 +8,7 @@ regions:
     payload_offset: 4
     absolute_offset: 70
     size: 206
-    used_size: 142
+    used_size: 148
   aux:
     payload_offset: 210
     absolute_offset: 276
@@ -18,8 +18,8 @@ root:
   data_size: 312
   payload_size: 245
   overhead: 67
-  payload_used_size: 147
-  total_used_size: 214
+  payload_used_size: 153
+  total_used_size: 220
 data:
   meta:
     aux_region_offset: 210
@@ -51,10 +51,13 @@ data:
     container_outer_diameter: 200
     container_inner_diameter: 100
     container_hole_diameter: 52
+    certifications:
+    - ul_2818
+    - ul_94_v0
   aux: {}
 raw_data:
   meta: a10218d2
-  main: bf041b000007d0fcab45f9056a33333463353466303838080009000a76504c412050727573612047616c61787920426c61636b0b6950727573616d656e740e1a68d3c7d7101903e8111903f41219011813433d3e3d181c9f17ff181df93cf6182218cd182318e1182418aa182518281826183c18271218281828182914182a1840182b18c8182c1864182d1834ff00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000
+  main: bf041b000007d0fcab45f9056a33333463353466303838080009000a76504c412050727573612047616c61787920426c61636b0b6950727573616d656e740e1a68d3c7d7101903e8111903f41219011813433d3e3d181c9f17ff181df93cf6182218cd182318e1182418aa182518281826183c18271218281828182914182a1840182b18c8182c1864182d183418389f0001ffff00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000
   aux: a000000000000000000000000000000000000000000000000000000000000000000000
 uri: https://3dtag.org/s/334c54f088
 opt_check:

tests/encode_decode/01_info.yaml

@@ -11,6 +11,7 @@ data:
     primary_color:
       hex: 3D3E3D
     tags: [glitter]
+    certifications: [ul_2818, ul_94_v0]
     density: 1.24
 
     # Package-spcific fields