Difference between revisions of "SHIP:Node:platform"

From Serious Documentation
Jump to: navigation, search
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
Within [[SHIPTide]] and the [[SHIPEngine]] environment every [[SIMs|SIM]] has a {{Node|platform}} section that contains it's [[Port|port]]s, [[Portvar|portvar]]s, and some basic information about the {{Node|platform}} itself.
+
<onlyinclude>Within [[SHIPTide]] and the [[SHIPEngine]] environment every [[SIMs|SIM]] has a {{Node|platform}} section that contains its [[SHIP:Port|port]]s, [[SHIP:Portvar|portvar]]s, and some basic information about the {{Node|platform}} itself.
  
 
In all SHIP GUI environments, the {{Node|platform}} node also has the fixed name of "{{Node|platform}}".  
 
In all SHIP GUI environments, the {{Node|platform}} node also has the fixed name of "{{Node|platform}}".  
 
The name "{{Node|platform}}" is reserved and unique, so it is a unique and specific reference to the [[SIMs|SIM platform]] on which the current GUI is running.  
 
The name "{{Node|platform}}" is reserved and unique, so it is a unique and specific reference to the [[SIMs|SIM platform]] on which the current GUI is running.  
−
All it's properties can be specified in "dot" notation with {{Node|platform}} followed by ".property",  
+
All its properties can be specified in "dot" notation with {{Node|platform}} followed by ".property",  
−
for example {{Prop|platform|id|'''platform.id'''}}.
+
for example '''platform.id'''.
  
 
The {{Node|platform}} node has the following properties, all of which are Read Only:
 
The {{Node|platform}} node has the following properties, all of which are Read Only:
 
{{PropTableStart|}}
 
{{PropTableStart|}}
−
|<onlyinclude>{{Prop|platform|id|platform.id}} (see [[SHIP:GRMs|GRM]])||{{DataType|Integer}}||A 32 bit hex value that consists of the Serious Integrated Inc. USB Vendor ID (0x25D8) followed by the (platform specific) USB Product ID for the USB device port on the [[SIMs|SIM]].
+
|{{:SHIP:Property:platform:id}}
 
|-
 
|-
−
|{{Prop|platform|vendor|platform.vendor}}||{{DataType|String}}||Constant value of "'''Serious'''".
+
|{{:SHIP:Property:platform:vendor}}
 
|-
 
|-
−
 
+
|{{:SHIP:Property:platform:model}}
−
|{{Prop|platform|model|platform.model}} (see [[SHIP:GRMs|GRM]])||{{DataType|String}}||Constant value holding the [[SIMs|SIM]]'s model name.
 
 
|-
 
|-
−
 
+
|{{:SHIP:Property:platform:sn}}
−
|{{Prop|platform|sn|platform.sn}}||{{DataType|String}}||String representation of the unique 64 bit serial number every [[SIMs|SIM]] has burned into it's hardware at manufacturing time. Serial numbers have a specific format; for more information contact ''Serious''.
 
 
|-
 
|-
−
 
+
|{{:SHIP:Property:platform:oemsn}}
−
|{{Prop|platform|oemsn|platform.oemsn}}||{{DataType|String}}||String representation of a customer-specific 64 bit serial number some custom [[SIMs|SIM]] variants have burned into their hardware at manufacturing time. For more information contact ''Serious''.</onlyinclude>
+
|}</onlyinclude>
−
|}
+
{{†}}see [[SHIP:GRMs|GRM]]

Latest revision as of 11:43, 4 April 2013

Within SHIPTide and the SHIPEngine environment every SIM has a platform section that contains its ports, portvars, and some basic information about the platform itself.

In all SHIP GUI environments, the platform node also has the fixed name of "platform". The name "platform" is reserved and unique, so it is a unique and specific reference to the SIM platform on which the current GUI is running. All its properties can be specified in "dot" notation with platform followed by ".property", for example platform.id.

The platform node has the following properties, all of which are Read Only:

Property Data Type Description
platform.id† Integer A 32 bit hex value that consists of the Serious Integrated Inc. USB Vendor ID (0x25D8) followed by the platform specific USB Product ID for the USB device port on the SIM.
platform.vendor String Constant value of "Serious".
platform.model† String Constant platform specific value holding the SIM's model name.
platform.sn String String representation of the unique 64 bit serial number every SIM has burned into its hardware at manufacturing time. Serial numbers have a specific format; for more information contact Serious.
platform.oemsn String String representation of a customer-specific 64 bit serial number some custom SIM variants have burned into their hardware at manufacturing time. For more information contact Serious.

†see GRM

Retrieved from "https://techref.myserious.com/index.php?title=SHIP:Node:platform&oldid=2936"