SIM115:GRM

From Serious Documentation
Jump to: navigation, search
  • See all GUI Reference Manuals (GRMs) here

SIM115 GUI Reference Manual

The Serious Human Interface™ Platform ("SHIP") is a complete rapid GUI development and deployment system. The SHIP Total IDE ("SHIPTide") is the PC-based GUI design tool which generates a complete GUI data file including fonts, images, layout, resources, events and scripts. This data file, called the "Cargo" is then downloaded into a SIM's storage (often serial FLASH). SHIPEngine is the runtime binary engine installed on the SIM that, when it boots, discovers the cargo binary and unpacks and renders the GUI.

When creating a GUI in SHIPTide, the developer often needs to interact in the GUI environment with the underlying hardware platform features, for example listen to the touch screen or dim the brightness on the LCD display.

Each major feature of the hardware platform is represented in the GUI environment as a port. For example, most SIMs have a glass port, a touch port, one or more uart ports, etc. Controlling and reading the features in each of these ports is done through special variables called port variables (specifically, portvars) that exist within their respective ports.

These GUI Reference Manuals (GRMs) are not meant to fully describe the functionality and typical usages of each port and portvar. Rather, this GRM is designed to outline what ports and portvars are available, appropriate value ranges, and any special usage notes. The broader description of ports and portvars, including example usages, is found elsewhere in applications notes and online training videos. Consult the SHIP Documentation Home Page for a complete list of references and training.

SIM115 Family Overview

The SIM115 is family of 3.5" QVGA TFT Graphic/Touch module powered by the Renesas RX631/RX63N MCU. Family features include:

  • 3.5" QVGA 320x240 color TFT display
  • 100MHz 32-bit Renesas RX621 MCU with Direct Drive
    • 125KB RAM, up to 768MB FLASH
    • On-MCU temperature sensor
  • On Module Memory
    • 8-16MB SDRAM
    • 8-16MB serial FLASH
    • 4KBit EEPROM
  • Extensive I/O
    • 16-pin communications and power connector
    • 60-pin docking communications expansion connector
    • SHIP Programming Port
    • Tag Connect TC2070 JTAG port
  • -20 to 70°C extended operating temperature

There are various family members with additional features, including:

  • USB Micro Device
  • USB A Embedded Host
  • Bi-color LED
  • Ambient Light Sensor
  • Proximity Detection
  • Battery backed clock

For the latest list of features and family variants, visit the SIM115 product page.

Platform Node

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.

Platform Specific Notes

Glass Port(s)

Glass ports are used to control the display of the SIM and are usually referred to in the format "platform.GLASS0", "platform.GLASS1", etc.

Portvar Data Type Permissions Description
kick Boolean Read/Write Toggling the value of kick resets the backlight timer (if set). The actual value is irrelevant; it is the change event that resets the backlight timer. As such, kick should always be assigned to the opposite of its current value (i.e. GLASS0.kick = !GLASS0.kick).
timeout Integer Read/Write The number of seconds until the backlight shuts off automatically. If kick is changed, the timer is reset to the full timeout value. If set to 0, the backlight will never shut off automatically. This value is always 0 (disabled) at boot. If a default value other than 0 is desired, store the desired value in a persistent variable in your GUI and load it into timeout at boot time using the shiplaunch event.
width Dimension Read Only This is the width (x), in pixels, of the SIM's display. (Default: platform specific)
height Dimension Read Only This is the height (y), in pixels, of the SIM's display. (Default: platform specific)
mirrorx Boolean Read/Write When set, the entire display is mirrored in the x direction. Can be used in conjunction with flipxy. (Default false)
mirrory Boolean Read/Write When set, the entire display is mirrored in the y direction. Can be used in conjunction with flipxy. (Defaultfalse)
flipxy Boolean Read/Write When set, the entire display is flipped on the x-y axis (portrait mode). Can be used in conjunction with mirrorx and/or mirrory. (Default: false)
bpp Byte Read Only Number of bits per pixel on the glass. The total number of displayable colors is 2 to the power of this number (e.g. 2^16 = 65536 total colors). (Default: platform specific)
backlight Byte Read/Write The brightness of the backlight between 0 (off) and 100 (max). Regulating backlight intensity can decrease power, increase longevity of the backlight hardware, and improve viewing in different lighting conditions. Setting this to an out of range value sets the backlight to max. (Default: 100)

Platform Specific Notes

  • SIM115 has a single LCD display; referred to by the name platform.GLASS0
  • For landscape mode, set width and height to 320 and 240 respectively
  • For portrait mode, set width and height to 240 and 320 respectively
  • bpp is 24 or 16 depending on the engine load

Touch Port(s)

Touch ports are used to read and configure the touch interface of the SIM and are usually referred to in the format "platform.TOUCH0", "platform.TOUCH1", etc.

Portvar Data Type Permissions Description
event Touch Read Only A complex datatype with several properties. (see Touch Events)
width Dimension Read Only This is the width (x), in pixels, of the SIM's display. (Default: platform specific)
height Dimension Read Only This is the height (y), in pixels, of the SIM's display. (Default: platform specific)
mirrorx Boolean Read/Write When set, the values received from touch events are mirrored in the x direction. Can be used in conjunction with flipxy. (Default: false)
mirrory Boolean Read/Write When set, the values received from touch events are mirrored in the y direction. Can be used in conjunction with flipxy. (Default: false)
flipxy Boolean Read/Write When set, the values received from touch events are flipped on the x-y axis (portrait mode). Can be used in conjunction with mirrorx and/or mirrory. (Default: false)

Platform Specific Notes

Not all SIM115 variants have touch; consult the SIM115 Features and Variants tables. For variants that do have touch, there is a single touch interface; referred to by the name platform.TOUCH0.

  • For landscape mode, set width and height to 320 and 240 respectively
  • For portrait mode, set width and height to 240 and 320 respectively

GPIO Port(s)

The GPIO port on SIM115 is named platform.GPIO and contains a variety of general purpose I/O portvars including:

Portvar Data Type Permissions Description
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.
pcbTemp Temperature Read Only Value of the on-board temperature sensor if present.
tempPrecision Byte Read/Write Controls the number of bits of precision of the pcbTemperature (SHIPv4) or pcbTemp (SHIPv5) reading. A value between 0 and 8; default value is 0.
ambLight Byte Read Only Reflects the current ambient light intensity, from 0 to 100%. Can be combined with backlight to make the LCD backlight brightness track the ambient light conditions.

Platform Specific Notes

  • If the on-board temperature sensor is not present on the platform, pcbTemp will read 23.00°C.

UART Port(s)

UART ports are used to configure the way a SIM communicates with some other device and are usually referred to in the format "platform.UART0", "platform.UART1", etc.

If you attempt to set an invalid value for any of these portvars, the value of the portvar will not be changed. (see UART_FLAGS)

Portvar Data Type Permissions Description
rate Integer Read/Write The baud rate.
bits UART_FLAG Read/Write The number of bits per character set.
stop UART_FLAG Read/Write The number of stop bits sent after each character set.
parity UART_FLAG Read/Write The parity bit sent after each character set.
txControl UART_FLAG Read/Write Sets how the hardware tx control line functions for full/half duplex transceiver control (default UART_FLAGS.TXC_UNUSED).

Platform Specific Notes

SPI Port(s)

SPI ports are used to configure the way a SIM communicates with some other device and are usually referred to in the format "platform.SPI0", "platform.SPI1", etc.

If you attempt to set an invalid value for any of these portvars, the value of the portvar will not be changed.

Portvar Data Type Permissions Description
rate Integer Read/Write The bit rate.

Platform Specific Notes

  • SIM115 has one SPI port referred to by the name platform.SPI0
  • rate default is 10,000,000

AudioOut Port(s)

AudioOut ports are used to configure or play sound through an audio speaker/amplifier and are usually referred to in the format "platform.AUDIOOUT".

Portvar Data Type Permissions Description
volume Byte Read/Write The volume of the audio output between 0 (off) and 100 (max). Setting this to an out of range value sets the volume to max. (Default: 100)
clip Reference:audioclip Read/Write Node reference of the last audioclip played (if any), otherwise a reference to the resources node. If set while another clip is playing, the sub-system will switch to the new audioclip immediately.
playing Boolean Read/Write Reflects whether or not clip is being played. When clip is finished, self-sets to false and resets the clip pointer to the beginning of clip. If set to false and clip has not finished, the clip pointer is not modified so playing can be resumed. To restart an unfinished clip, reassign the same clip to clip before setting to true.

Platform Specific Notes

  • SIM115 has a single AudioOut port; referred to by the name platform.AUDIOOUT

Beep Port(s)

Beep ports are used to play sound through piezo-electric buzzers or audio speakers/amplifiers and are usually referred to in the format "platform.BEEP".

Portvar Data Type Permissions Description
volume Byte Read/Write The volume between 0 (off) and 100 (max). Setting this to an out of range value sets the volume to max. (Default:100)
frequency Short Read/Write The frequency the piezo-electric buzzer should emit. The buzzer's most efficient frequency is platform specific.
playing Boolean Read/Write Starts/stops the buzzer from producing noise.

Platform Specific Notes

  • SIM115 has a single Beep port; referred to by the name platform.BEEP
  • Beep ports on this platform will use the audio speaker/amplifier.
  • frequency is 2400