<!-- If the browser does not support frames put the first topic content here --> <div class="WordSection1"> <p class="MsoTitle" align="center" style='text-align:center'> <a name="_Toc502621039"><span lang="EN" xml:lang="EN">Smart.IO User Guide</span></a></p> <p class="MsoNormal" align="center" style='text-align:center'> <span lang="EN" xml:lang="EN">Version 1.01 2019/07/17</span></p> <p class="MsoNormal" align="center" style='text-align:center'> <span lang="EN" xml:lang="EN">Copyright © 2018-2019</span></p> <p class="MsoNormal" align="center" style='text-align:center'> <a href="mailto:info@imagecraft.com"><span lang="EN" style= 'color:#1155CC' xml:lang="EN">info@imagecraft.com</span></a></p> <p class="MsoNormal" align="center" style='text-align:center'> <a href="https://imagecraft.com/"><span lang="EN" style= 'color:#1155CC' xml:lang="EN">https://imagecraft.com</span></a></p> <p class="MsoNormal" align="center" style='text-align:center'> <span lang="EN" xml:lang="EN"> </span></p> <p class="MyBody"><span lang="EN" xml:lang="EN">This is the user guide for ImageCraft’s Smart.IO product.</span></p> <p class="MsoNormal"><span lang="EN" style= 'font-size:26.0pt;line-height:115%' xml:lang="EN"> </span></p> <span lang="EN" style= 'font-size:11.0pt;line-height:115%;font-family:"Arial",sans-serif' xml:lang="EN"><br clear="all" style= 'page-break-before:always' /></span> <p class="MsoNormal"><span lang="EN" style= 'font-size:26.0pt;line-height:115%' xml:lang="EN"> </span></p> </div>
Contents
Topics
Search
Help content
OVERVIEW
Introduction
Firmware Driven UI
Where to Find Information
Overview of the Smart.IO System
Customized App for Product Release
Evaluating Smart.IO Using the Smart.IO Starter Kit
ST-Nucleo Driver
UI Demo
Command Demo
Setting up the terminal programs
Startup operations
Running the test program
Modifying the test program
INTEGRATING WITH SMART.IO
Hardware Integration Guide
Physical dimensions:
Power Requirements
Smart.IO Module Placement Recommendations
5V System Compatibility
2x6 0.1” Header
Microcontroller Interface
SPI
Host IRQ
Smart.IO RESET
UART Pins
Bootloader Mode
JTAG pins
Arduino Style Shield
Arduino Shield Header Pinouts
ST-Nucleo Boards with Arduino-style Headers
AVR Arduino
Arduino Shield JTAG Header Pinouts
Software Integration Guide
Smart.IO API
Host Interface Layer Architecture
Blocking API
Interrupts
Host Interface Layer Source Files
Porting Tasks
Hardware Initializations
SPI Data Transfer
Host IRQ Interrupt Handling
Other Source Files in the Host Interface Layer
Example of Porting Using ST LL (Low Level)
Hardware Pin Usage
Target Hardware Initialization
Writing a Byte Sequence Via SPI
SPI Write Byte
Reading Data From the SPI
End of Data Read Transaction
Host Interrupt Handler
Error Function
That’s It!
Complete Data Flow of a Smart.IO API Call
Logic Analyzer Display of Initial Connect
Smartphone App
Some Sample Screens and Additional Features
Caching - an In-App Purchase Option
A Program Template
Naming Conventions
Example UI
Main Loop
Save and Restore UI State
Creating the UI
UI Callback Functions
Initial Setup
Summary
UI DESIGN
GUI Slice
Virtual Screen Sizes and Screen Orientation
UI Control Alignment
UI ELEMENTS
Input UI Elements
Adding List Items
On/Off buttons
3-Position Button
Slider
Incrementor
Expandable List
Picker
Multi-Selector
Number Selector
Time Selector
Analog Time Selector
Calendar Selector
Weekday Selector
OK Button
OK_LINKTO Button
CANCEL/OK Button
Checkboxes
Radio Buttons
Text Entry
Password Entry
Output UI Elements
Label
Text Box
Multiline Box
Counter
Progress Bar
Progress Circle
Horizontal Gauge
Vertical Gauge
Custom Horizontal Gauge
Custom Vertical Gauge
Semicircular Gauge
Circular Gauge
Battery Level
RGB LED
API INTRODUCTION
API Categories
Terminology
App Version
Error Conditions
Memory Blocks
UI Cache
Local Storage
API Dataflow
Callback Functions
Data Types, Strings and Transfer Memory
API FUNCTION DESCRIPTIONS
Initialization Function
Page Management
Input UI Elements
Output UI Elements
Auto Layout and Groups
Enable-If Command
Update Functions
Popups
Freeform Slices
Popup Alerts
UI Element States
Miscellaneous UI Functions
Fonts
Text Control Codes
Color Values
Miscellaneous
App Menu
App Title
Page Title
EEPROM Commands
System Commands
Miscellaneous System Commands
Phone Commands
APPENDIX
A: Using Smart.IO EEPROM for UI State Storage
B: Smart.IO Module Schematic
C: Smart.IO Arduino Shield Schematic
2x6 0.1” Header
3-Position Button
5V System Compatibility
A Program Template
A: Using Smart.IO EEPROM for UI State Storage
Adding List Items
Analog Time Selector
API Dataflow
API Categories
API FUNCTION DESCRIPTIONS
API INTRODUCTION
App Menu
App Title
App Version
APPENDIX
Arduino Shield Header Pinouts
Arduino Shield JTAG Header Pinouts
Arduino Style Shield
Auto Layout and Groups
AVR Arduino
B: Smart.IO Module Schematic
Battery Level
Blocking API
Bootloader Mode
C: Smart.IO Arduino Shield Schematic
Caching - an In-App Purchase Option
Calendar Selector
Callback Functions
CANCEL/OK Button
Checkboxes
Circular Gauge
Color Values
Command Demo
Complete Data Flow of a Smart.IO API Call
Counter
Creating the UI
Custom Horizontal Gauge
Custom Vertical Gauge
Customized App for Product Release
Data Types, Strings and Transfer Memory
EEPROM Commands
Enable-If Command
End of Data Read Transaction
Error Conditions
Error Function
Evaluating Smart.IO Using the Smart.IO Starter Kit
Example UI
Example of Porting Using ST LL (Low Level)
Expandable List
Firmware Driven UI
Fonts
Freeform Slices
GUI Slice
Hardware Initializations
Hardware Integration Guide
Hardware Pin Usage
Help content
Horizontal Gauge
Host Interface Layer Architecture
Host Interface Layer Source Files
Host IRQ
Host IRQ Interrupt Handling
Host Interrupt Handler
Incrementor
Initial Setup
Initialization Function
Input UI Elements
Input UI Elements
INTEGRATING WITH SMART.IO
Interrupts
Introduction
JTAG pins
Label
Local Storage
Logic Analyzer Display of Initial Connect
Main Loop
Memory Blocks
Microcontroller Interface
Miscellaneous
Miscellaneous UI Functions
Miscellaneous System Commands
Modifying the test program
Multi-Selector
Multiline Box
Naming Conventions
Number Selector
OK Button
OK_LINKTO Button
On/Off buttons
Other Source Files in the Host Interface Layer
Output UI Elements
Output UI Elements
OVERVIEW
Overview of the Smart.IO System
Page Management
Page Title
Password Entry
Phone Commands
Physical dimensions:
Picker
Popup Alerts
Popups
Porting Tasks
Power Requirements
Progress Bar
Progress Circle
Radio Buttons
Reading Data From the SPI
RGB LED
Running the test program
Save and Restore UI State
Semicircular Gauge
Setting up the terminal programs
Slider
Smart.IO Module Placement Recommendations
Smart.IO RESET
Smart.IO API
Smartphone App
Software Integration Guide
Some Sample Screens and Additional Features
SPI
SPI Data Transfer
SPI Write Byte
ST-Nucleo Boards with Arduino-style Headers
ST-Nucleo Driver
Startup operations
Summary
System Commands
Target Hardware Initialization
Terminology
Text Control Codes
Text Entry
Text Box
That’s It!
Time Selector
UART Pins
UI Cache
UI Callback Functions
UI Element States
UI Control Alignment
UI Demo
UI DESIGN
UI ELEMENTS
Update Functions
Vertical Gauge
Virtual Screen Sizes and Screen Orientation
Weekday Selector
Where to Find Information
Writing a Byte Sequence Via SPI
Generated with
chmProcessor
Generated with
chmProcessor