MightyPirates · Jun 4, 2016
diff --git a/Diff for: ‎src/main/java/li/cil/oc/api/driver/DeviceInfo.java
+58 b/Diff for: ‎src/main/java/li/cil/oc/api/driver/DeviceInfo.java
+58
diff --git a/Diff for: ‎src/main/scala/li/cil/oc/Constants.scala
+1-33 b/Diff for: ‎src/main/scala/li/cil/oc/Constants.scala
+1-33
@@ -36,4 +36,62 @@ public interface DeviceInfo {
      * @return the table of information on this device, or <code>null</code>.
      */
     Map<String, String> getDeviceInfo();
+
+    /**
+     * Recommended list of key values for the device info table.
+     * <p/>
+     * You are strongly encouraged to at least define <code>class</code>, <code>description</code>,
+     * <code>vendor</code> and <code>product</code>, to allow a more homogenous experience for the
+     * end-user reading this information via a script.
+     * <p/>
+     * Feel free to be somewhat... flexible with the designated uses of these fields. For example,
+     * the capacity and size fields have differing meaning depending on the device in OpenComputers
+     * itself (e.g. they're used for maximum number of characters for graphics cards, width is
+     * used for bit depth on graphics cards, etc.), just try to stick with what's somewhat logical.
+     */
+    final class DeviceAttribute {
+        public static final String Class = "class"; // device's class (see below), e.g. "processor"
+        public static final String Description = "description"; // human-readable description of the hardware node, e.g. "Ethernet interface"
+        public static final String Vendor = "vendor"; // vendor/manufacturer of the device, e.g. "Minecorp Inc."
+        public static final String Product = "product"; // product name of the device, e.g. "ATY Raderps 4200X"
+        public static final String Version = "version"; // version/release of the device, e.g. "2.1.0"
+        public static final String Serial = "serial"; // serial number of the device
+        public static final String Capacity = "capacity"; // maximum capacity reported by the device, e.g. unformatted size of a disk
+        public static final String Size = "size"; // actual size of the device, e.g. actual usable space on a disk
+        public static final String Clock = "clock"; // bus clock (in Hz) of the device, e.g. call speed(s) of a component
+        public static final String Width = "width"; // address width of the device, in the broadest sense
+
+        private DeviceAttribute() {
+        }
+    }
+
+    /**
+     * Recommended list of values for the <code>class</code> attribute (see above).
+     * <p/>
+     * Again, feel free to be somewhat creative with those. When in doubt, use <code>generic</code>.
+     */
+    final class DeviceClass {
+        public static final String System = "system"; // used to refer to the whole machine, e.g. "Computer", "Server", "Robot"
+        public static final String Bridge = "bridge"; // internal bus converter, maybe useful for some low-level archs?
+        public static final String Memory = "memory"; // memory bank that can contain data, executable code, e.g. RAM, EEPROM
+        public static final String Processor = "processor"; // execution processor, e.g. CPU, cryptography support
+        public static final String Address = "address"; // memory address range, e.g. video memory (again, low-level archs maybe?)
+        public static final String Storage = "storage"; // storage controller, e.g. IDE controller (low-level...)
+        public static final String Disk = "disk"; // random-access storage device, e.g. floppies
+        public static final String Tape = "tape"; // sequential-access storage device, e.g. cassette tapes
+        public static final String Bus = "bus"; // device-connecting bus, e.g. USB
+        public static final String Network = "network"; // network interface, e.g. ethernet, wlan
+        public static final String Display = "display"; // display adapter, e.g. graphics cards
+        public static final String Input = "input"; // user input device, e.g. keyboard, mouse
+        public static final String Printer = "printer"; // printing device, e.g. printer, 3D-printer
+        public static final String Multimedia = "multimedia"; // audio/video device, e.g. sound cards
+        public static final String Communication = "communication"; // line communication device, e.g. modem, serial ports
+        public static final String Power = "power"; // energy source, e.g. battery, power supply
+        public static final String Volume = "volume"; // disk volume, e.g. file system
+        public static final String Generic = "generic"; // generic device (used when no other class is suitable)
+
+        private DeviceClass() {
+        }
+    }
+
 }
@@ -173,39 +173,7 @@ object Constants {
 
   object DeviceInfo {
 
-    object DeviceAttribute {
-      final val Class = "class"
-      final val Description = "description"
-      final val Vendor = "vendor"
-      final val Product = "product"
-      final val Capacity = "capacity"
-      final val Size = "size"
-      final val Clock = "clock"
-      final val Width = "width"
-    }
-
-    object DeviceClass {
-      final val System = "system"
-      final val Bridge = "bridge"
-      final val Memory = "memory"
-      final val Processor = "processor"
-      final val Address = "address"
-      final val Storage = "storage"
-      final val Disk = "disk"
-      final val Tape = "tape"
-      final val Bus = "bus"
-      final val Network = "network"
-      final val Display = "display"
-      final val Input = "input"
-      final val Printer = "printer"
-      final val Multimedia = "multimedia"
-      final val Communication = "communication"
-      final val Power = "power"
-      final val Volume = "volume"
-      final val Generic = "generic"
-    }
-
-    final val DefaultVendor = "MightPirates GmbH & Co. KG"
+    final val DefaultVendor = "MightyPirates GmbH & Co. KG"
 
   }