Difference between revisions of "SHIP:Port:gpio"

From Serious Documentation
Jump to: navigation, search
(Created page with "GPIO ports are used to either read or control various hardware elements of the SIM and are usually referred to in the format "'''platform.GPIO'''". It should be noted...")
 
Line 4: Line 4:
 
''Note: The GPIO portvars in this comprehensive list were collected from '''all''' [[SIMs|SIM]] platforms and may '''not''' appear on every platform. However, when a portvar is implemented on your platform, it will function as described below. Refer to you platform's [[SHIP:GRMs|GRM]].''
 
''Note: The GPIO portvars in this comprehensive list were collected from '''all''' [[SIMs|SIM]] platforms and may '''not''' appear on every platform. However, when a portvar is implemented on your platform, it will function as described below. Refer to you platform's [[SHIP:GRMs|GRM]].''
 
{{PortvarTableStart|}}
 
{{PortvarTableStart|}}
−
|{{Portvar|gpio|SW1}}||{{DataType|Boolean}}||Read Only||
+
|{{:SHIP:Port:gpio:SW1}}
 
|-
 
|-
−
||{{Portvar|gpio|LEDR}}||{{DataType|Boolean}}||Read/Write||
+
|{{:SHIP:Port:gpio:LEDR}}
 
|-
 
|-
−
||{{Portvar|gpio|LEDG}}||{{DataType|Boolean}}||Read/Write||
+
|{{:SHIP:Port:gpio:LEDG}}
 
|-
 
|-
−
||{{Portvar|gpio|LEDRR}}||{{DataType|Boolean}}||Read/Write||
+
|{{:SHIP:Port:gpio:LEDRR}}
 
|-
 
|-
−
||{{Portvar|gpio|LEDRG}}||{{DataType|Boolean}}||Read/Write||
+
|{{:SHIP:Port:gpio:LEDRG}}
 
|-
 
|-
−
||{{Portvar|gpio|LEDLR}}||{{DataType|Boolean}}||Read/Write||
+
|{{:SHIP:Port:gpio:LEDLR}}
 
|-
 
|-
−
||{{Portvar|gpio|LEDLG}}||{{DataType|Boolean}}||Read/Write||
+
|{{:SHIP:Port:gpio:LEDLG}}
 
|-
 
|-
−
||{{Portvar|gpio|pcbTemperature}}||{{DataType|Short}}||Read Only||
+
|{{:SHIP:Port:gpio:pcbTemperature}}
 
|-
 
|-
−
||{{Portvar|gpio|extPowerPresent}}||{{DataType|Boolean}}||Read Only||
+
|{{:SHIP:Port:gpio:extPowerPresent}}
 
|-
 
|-
−
||{{Portvar|gpio|usbfPowerPresent}}||{{DataType|Boolean}}||Read Only||
+
|{{:SHIP:Port:gpio:usbfPowerPresent}}
 
|-
 
|-
−
||{{Portvar|gpio|batLevel}}||{{DataType|Boolean}}||Read Only||
+
|{{:SHIP:Port:gpio:batLevel}}
 
|-
 
|-
−
||{{Portvar|gpio|batStatus}}||{{DataType|Boolean}}||Read Only||
+
|{{:SHIP:Port:gpio:batStatus}}
 
|-
 
|-
−
||{{Portvar|gpio|audioPowerGood}}||{{DataType|Boolean}}||Read Only||
+
|{{:SHIP:Port:gpio:audioPowerGood}}
 
|}
 
|}

Revision as of 13:16, 1 February 2013

GPIO ports are used to either read or control various hardware elements of the SIM and are usually referred to in the format "platform.GPIO". It should be noted that each platform may or may not implement any of the portvars listed below and you should refer to your SIM's GRM for the exact specifications of available GPIO portvars supported by your platform.

Complete List of GPIO Portvars

Note: The GPIO portvars in this comprehensive list were collected from all SIM platforms and may not appear on every platform. However, when a portvar is implemented on your platform, it will function as described below. Refer to you platform's GRM.

Portvar Data Type Permissions Description
SW1 Boolean Read Only Reflects the logical state of the pushbutton designated as SW1 by the platform. Reads true when pressed.
LEDR Boolean Read/Write Turns a SIM's red LED on when set to true. Can be combined with LEDG to make the LED look orange.
LEDG Boolean Read/Write Turns a SIM's green LED on when set to true. Can be combined with LEDR to make the LED look orange.
LEDRR Boolean Read/Write Turns a SIM's right red LED on when set to true. Can be combined with LEDRG to make the right LED look orange.
LEDRG Boolean Read/Write Turns a SIM's right green LED on when set to true. Can be combined with LEDRR to make the right LED look orange.
LEDLR Boolean Read/Write Turns a SIM's left red LED on when set to true. Can be combined with LEDLR to make the left LED look orange.
LEDLG Boolean Read/Write Turns a SIM's left green LED on when set to true. Can be combined with LEDLR to make the left LED look orange.
pcbTemperature Temperature Read Only Value of the on-board temperature sensor if present (SHIPv4; renamed to pcbTemp in SHIPv5)
SHIP:Port:gpio:extPowerPresent
SHIP:Port:gpio:usbfPowerPresent
batLevel Byte Read Only Reflects the remaining percentage of the connected LiPo battery or 0 if not connected.
batStatus BAT_STATUS Read Only Reflects the status of the LiPo battery.
audioPowerGood Boolean Read Only Reports whether the platform has enough power to support the on-board audio speaker/amplifier circuitry. Reads true when the SIM is supplied with sufficient power.
Retrieved from "https://techref.myserious.com/index.php?title=SHIP:Port:gpio&oldid=2653"