1. Catalogs
  2. IQRF Tech
  3. IQRF Quick Start Guide

IQRF Quick Start Guide

IQRF Quick Start Guide
1 / 18 PagesView full catalog

IQRF Quick Start Guide

Product catalog summary
IQRF Quick Start Guide Overview
This guide provides a comprehensive introduction to starting with IQRF OS v4.03D, detailing the necessary components, hardware, software, and application approaches for effective use.
Components Required
The essential tools include an IQRF development set and the IQRF Startup package, which includes the IQRF IDE development environment. A compatible PC with Windows Vista or later is also required.
Development Hardware
  • Development Set: The DS-START-04 or DS-DPA-02 sets contain all necessary hardware and software for startup, including TR transceivers, a programmer, and a USB flash drive with software and documentation.
  • TR Transceivers: These are programmable under the IQRF OS and support the DPA approach for applications without programming.
  • Programmer: The CK-USB-04A kit is used for uploading application codes and configuring TR parameters.
  • End Devices: TRs are hosted in portable DK-EVAL-04A kits, with USB connectivity primarily for charging.
  • USB Device: TRs can be connected to a PC via USB for control and management using IQRF IDE tools.
Typical Usage of Kits
  • First Demonstration: Involves checking RF link using two TR transceivers and DK-EVAL-04A kits, with LED indicators for transmitted and received packets.
  • Point-to-Point: Utilizes two DK-EVAL-04A kits or CK-USB-04A for basic examples like E01-TX and E02-RX.
  • Network: Implementing an IQMESH network is recommended using the DPA approach with ready-to-use plug-ins.
Two Application Approaches
  • Without Programming: Utilizes DPA plug-ins for communication in Mesh networks without programming, controlled via SPI or UART by the DPA protocol.
  • Programming in C: Allows for custom functionality directly under IQRF OS using C language.
Development Software
The IQRF Startup package includes all necessary software and documentation, organized into directories for development, documentation, examples, and miscellaneous utilities.
C-Programming
Details on design steps, basic TR modes, debugging, and application examples are provided for programming in C.
Quick Start with DPA Without Programming
Instructions for using the DS-DPA-02 development set, including preparation, upload, bonding, discovery, examples, and unbonding processes.
Recommended Documentation
Additional documentation is recommended for further understanding and effective use of IQRF technology.
Document Revision
Information on document revisions is provided.
Sales and Service
Contact details for corporate office, technology and development, partners and distribution, quality management, trademarks, legal, and online support are included.
Quick Start Guide Overview
This document provides a comprehensive guide for setting up and using IQRF technology, focusing on software installation, project initiation, and device configuration. It is essential for developers working with IQRF transceivers and related software tools.
New and Older Projects
For new projects, always use the latest software versions, including the IQRF OS. For maintaining older projects, select the appropriate Startup package version based on the IQRF OS version in your transceivers.
PC Software Requirements
  • IQRF IDE: An integrated development environment for creating, debugging, and managing IQRF applications. Always use the latest version.
  • USB Drivers: Required for IQRF USB devices, primarily using the Custom class. CDC class is optional.
  • CC5X Compiler: A C compiler for PIC microcontrollers, included in the Startup package.
  • Text Editor: Notepad++ is recommended for editing source code.
Installation Steps
  1. Ensure no IQRF USB device is connected.
  2. Unzip the Startup package.
  3. Install IQRF IDE and follow the installation instructions.
  4. Connect the CK-USB-04A to the PC and launch IQRF IDE.
  5. Set your preferred text editor in the IDE options.
IQRF IDE Usage
The IDE integrates tools for application development, including programming, debugging, and network management. Projects must be defined with necessary files and configurations.
C-Programming
Programming in C is necessary for custom DPA handlers or applications under IQRF OS. The Startup package includes demo projects and examples for guidance.
Design Steps
Steps include plugging the TR into the CK-USB-04A, opening a new project, adding source files, compiling, and uploading the program to the TR.
Quick Start with DPA
This section provides a step-by-step guide for using the DPA approach, including preparation, uploading, bonding, discovery, and testing of network functionality.
Recommended Documentation
Includes video tutorials, technical guides, user guides, and datasheets for further reference and detailed understanding of IQRF technology.
Introduction and Updates:
The document outlines updates and changes made to the IQRF OS and related components over various versions. Notable changes include modifications in the R configuration and bonding steps in version 4.02D, updates for IQRF OS v4.01D due to a serious bug, and the first release for IQRF Quick Start Guide merged with IQRF DPA Quick Start Guide.

Quick Start Guide:
The guide is intended for users of IQRF transceivers and provides a quick start for using IQRF OS and DPA. It includes updates for specific transceiver models and software versions.

Sales and Service Information:
  • Corporate Office: IQRF Tech s.r.o., located in Jicin, Czech Republic, provides contact details for commercial inquiries.
  • Technology and Development: Technical support is available through their website and support email.
  • Partners and Distribution: Information on sales and distribution partners is available online.
  • Quality Management: The company is ISO 9001:2009 certified.
  • Trademarks: IQRF and related logos are registered trademarks, with other trademarks belonging to their respective owners.
  • Legal Information: The document includes disclaimers about the accuracy and use of the information, and restrictions on reproduction without permission.
  • Online Support: Support is available via email.
See more

Catalog excerpts

IQRF Quick Start Guide-1

Smarter Wireless. Simply. 2019 IQRF Tech s.r.o. www.iqrf.org Quick_Start_Guide_IQRF _190117 Page 1

 Open the catalog to page 1
IQRF Quick Start Guide-3

How to start the first IQRF design IQRF start-up is also illustrated on IQRF Video tutorial set. 1 Components required Just the following tools are needed: • HW: IQRF development set • SW: IQRF Startup package (free) including IQRF IDE development environment • PC: Windows Vista, Windows 7, Windows 8, Windows 8.1 or Windows 10 2 Development hardware 2.1 Development set IQRF development set DS-START-04 (see the picture below) or DS-DPA-02 (see chapter DS-DPA-02 development set) contains all HW and SW needed for effective start-up. DS-START-04: • DK-EVAL-04A Universal portable development kit...

 Open the catalog to page 3
IQRF Quick Start Guide-4

QUICK START 2.3 Programmer To upload application codes into TRs and configure TR parameters, the CK-USB-04A kit is intended. 2.4 End devices TRs (with application functionality codes uploaded using the programmer in advance) should be hosted in portable DK-EVAL-04A kits. USB connector is intended just for accumulator charging but not for USB connectivity. 2.5 USB device TRs can also be hosted by CK-USB-04A connected to PC via USB. It enables to control the TR application from PC, first of all by the IQRF IDE powerful tools for communication, testing, network management and visualization. This...

 Open the catalog to page 4
IQRF Quick Start Guide-5

QUICK START 3 Typical usage of kits 3.1 First demonstration RF link check ● Unpack two TR transceivers from the development set. Do not make any changes in SW inside. ● Plug the first TR into one DK-EVAL-04A kit and switch the power on by the jumper. Every transmitted RF packet is indicated by a green LED flash. ● Plug the second TR into another DK-EVAL-04A kit and switch the power on by the jumper. Every transmitted RF packet is indicated by a green LED flash. ● Moreover, transmitted packets are started to be received by the counterparts. Every received RF packet is indicated by the red LED...

 Open the catalog to page 5
IQRF Quick Start Guide-6

QUICK START 3.3 Network The only way to implement an IQMESH network is the DPA approach. For a quick startup, it is recommended to apply the ready-to-use DPA plug-ins without Custom DPA Handlers. See chapter Quick start with DPA without programming. 4 Two application approaches Specific functionality can be implemented into TR in one of the following two application approaches. 4.1 Without programming Higher level, running under DPA and utilizing DPA plug-ins, which are ready-to-use SW plug-ins enabling communication in Mesh networks with no need for programming. TR is not controlled by an application...

 Open the catalog to page 6
IQRF Quick Start Guide-7

QUICK START 5 Development software All software and documentation is available in a single IQRF Startup package. It is also delivered on the USB Flash drive inside development sets. The Startup package directory tree: IQRF_OS403_7xD ├───Development │ ├───DPA │ │ ├───DPA-Node-interfaces │ │ └───OTA_upgrade │ └───include │ ├───DPA │ └───IQRF_OS ├───Documentation │ ├───HW │ └───SW │ └───IQRF_Standard ├───Examples │ ├───DPA │ │ ├───CustomDpaHandlerExamples │ │ │ ├───hex │ │ │ │ └───IQRF_Standard │ │ │ └───IQRF_Standard │ │ ├───IoT-StarterKit-01 │ │ └───StartUp │ ├───IQRF_OS │ │ ├───Advanced_examples...

 Open the catalog to page 7
IQRF Quick Start Guide-8

QUICK START New project When starting a new project, always use the newest parts as well as the newest software versions including the IQRF OS (which is upgradeable). Older project If an older project should be maintained, go to the Archive to select the proper Startup package version according to the IQRF OS version inside your TR transceivers. 5.1 PC software IQRF IDE Integrated development environment by IQRF Tech to create, debug and control IQRF applications and manage the IQRF network. Required minimal IQRF IDE version depends on IQRF OS version of given TR transceiver and possibly also...

 Open the catalog to page 8
IQRF Quick Start Guide-9

QUICK START 5.5 IQRF IDE usage IQRF IDE environment integrates all SW tools needed for application development (and a lot of utilities for the following control, maintenance and service). It is project oriented. Thus, a Project containing necessary definitions and files must be specified first. Default Projects are available for immediate start. Project definition files have the .IQRFPRJ extension. See IQRF IDE Help for details. Programming and uploading procedure Programming – a creation of a user-specific IQRF application program. ● Editing – creation / modification of source code in C language....

 Open the catalog to page 9
IQRF Quick Start Guide-10

QUICK START 6 C-programming Programming in C language is needed: ● When DPA is used and given ready-to-use DPA plug-in has to be extended by a user-specific Custom DPA Handler. ● When the application is written under IQRF OS, without DPA. Programming in C language is not needed when DPA is used and some existing Custom DPA Handler is to be used without modification or no Custom DPA Handler is required at all. If DPA is used, once the DPA plug-in is uploaded, it is not necessary to upload it anymore when just the Custom DPA Handler is changed. The Startup Package contains: ● Demo Projects:  Under...

 Open the catalog to page 10
IQRF Quick Start Guide-11

• Programming • Run • Debug 6.2 Basic TR modes The mode allowing to upload the application into TR, e.g. via IQRF IDE. See IQRF SPI Technical guide, chapter TR upload. The application is running (executing the application program or DPA plug-in). The application execution is stopped at the selected breakpoint for testing. See chapter Debug below. 6.3 Debug The operating system offers the breakpoint(n) macro to be placed in the source code wherever you wish to stop and watch results (e.g. display internal variables and registers). After selecting the Skip Breakpoint button, the application continues...

 Open the catalog to page 11
IQRF Quick Start Guide-12

7 Quick start with DPA without programming This chapter is intended as a step-by-step guide to get familiar with the DPA approach. DS-DPA-02 development set To learn the DPA usage, development set DS-DPA-02 can be used. • DK-EVAL-04A Universal portable development kit for TR transceivers 4 pcs • CAB-USBABMICRO Micro USB cable 18.5 cm 2 pcs • USB flash drive Software and documentation 1 pc 1. Preparation All SW, plug-ins, documentation etc. are available on the flash disk and on www.iqrf.org/support/download. • Prepare TR-72DATs with OS 4.03D as follows: 5 pcs as the...

 Open the catalog to page 12
*Prices are pre-tax. They exclude delivery charges and customs duties and do not include additional charges for installation or activation options. Prices are indicative only and may vary by country, with changes to the cost of raw materials and exchange rates.