Merge pull request #63 from fusioninventory/better-consumable-specifi…

…cation more modular consumables description
fusioninventory · Oct 9, 2020 · e276af4 · e276af4
2 parents 2860e9e + 84a3e10
commit e276af4
Showing 1 changed file with 14 additions and 1 deletion.
diff --git a/documentation/dev/spec/protocol/netinventory.md b/documentation/dev/spec/protocol/netinventory.md
@@ -10,7 +10,7 @@ title: Network inventory protocol
 ### Specification
 
     {
-	    'id': ''string'',
+            'id': ''string'',
         'type': 'netinventory',
         'workers': ''integer'',
         'targets': [
@@ -255,6 +255,7 @@ title: Network inventory protocol
 
           <!-- CARTRIDGES node can content any meaningful printer cartridge info
           and it is up to the server to interpret given keys and values -->
+          <!-- this element is deprecated, CONSUMABLES should be used instead -->
           <!ELEMENT CARTRIDGES ANY>
           <!-- Following lines are well-known samples, so they are kept as comment
             <!ELEMENT CARTRIDGEBLACK (#PCDATA)>
@@ -285,6 +286,18 @@ title: Network inventory protocol
             <!ELEMENT CARTRIDGEPHOTOBLACK (#PCDATA)>
             End of samples -->
 
+          <!-- consumables list ->
+          <!ELEMENT CONSUMABLES (CONSUMABLE)+>
+
+            <!-- a single consumable ->
+            <!ELEMENT CONSUMABLE (TYPE, COLOR, VALUE, UNIT)>
+              <!ELEMENT TYPE (#PCDATA)>
+              <!ELEMENT COLOR (#PCDATA)>
+              <!ELEMENT VALUE (#PCDATA)>
+              <!ELEMENT UNIT (#PCDATA)>
+              <!-- use MAX if available, or assume it's 100 when UNIT is not set -->
+              <!ELEMENT MAX (#PCDATA)>
+
         <!-- netinventory module version(string) -->
         <!ELEMENT MODULEVERSION (#PCDATA)>
         <!-- server process ID (integer) -->