DALI Control Gear Library and Demo Application User s Guide

Transcription

1 DALI Control Gear Library and Demo Application User s Guide 2014 Microchip Technology Inc. DS A

2 Note the following details of the code protection feature on Microchip devices: Microchip products meet the specification contained in their particular Microchip Data Sheet. Microchip believes that its family of products is one of the most secure families of its kind on the market today, when used in the intended manner and under normal conditions. There are dishonest and possibly illegal methods used to breach the code protection feature. All of these methods, to our knowledge, require using the Microchip products in a manner outside the operating specifications contained in Microchip s Data Sheets. Most likely, the person doing so is engaged in theft of intellectual property. Microchip is willing to work with the customer who is concerned about the integrity of their code. Neither Microchip nor any other semiconductor manufacturer can guarantee the security of their code. Code protection does not mean that we are guaranteeing the product as unbreakable. Code protection is constantly evolving. We at Microchip are committed to continuously improving the code protection features of our products. Attempts to break Microchip s code protection feature may be a violation of the Digital Millennium Copyright Act. If such acts allow unauthorized access to your software or other copyrighted work, you may have a right to sue for relief under that Act. Information contained in this publication regarding device applications and the like is provided only for your convenience and may be superseded by updates. It is your responsibility to ensure that your application meets with your specifications. MICROCHIP MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND WHETHER EXPRESS OR IMPLIED, WRITTEN OR ORAL, STATUTORY OR OTHERWISE, RELATED TO THE INFORMATION, INCLUDING BUT NOT LIMITED TO ITS CONDITION, QUALITY, PERFORMANCE, MERCHANTABILITY OR FITNESS FOR PURPOSE. Microchip disclaims all liability arising from this information and its use. Use of Microchip devices in life support and/or safety applications is entirely at the buyer s risk, and the buyer agrees to defend, indemnify and hold harmless Microchip from any and all damages, claims, suits, or expenses resulting from such use. No licenses are conveyed, implicitly or otherwise, under any Microchip intellectual property rights. QUALITY MANAGEMENT SYSTEM CERTIFIED BY DNV == ISO/TS == Trademarks The Microchip name and logo, the Microchip logo, dspic, FlashFlex, KEELOQ, KEELOQ logo, MPLAB, PIC, PICmicro, PICSTART, PIC 32 logo, rfpic, SST, SST Logo, SuperFlash and UNI/O are registered trademarks of Microchip Technology Incorporated in the U.S.A. and other countries. FilterLab, Hampshire, HI-TECH C, Linear Active Thermistor, MTP, SEEVAL and The Embedded Control Solutions Company are registered trademarks of Microchip Technology Incorporated in the U.S.A. Silicon Storage Technology is a registered trademark of Microchip Technology Inc. in other countries. Analog-for-the-Digital Age, Application Maestro, BodyCom, chipkit, chipkit logo, CodeGuard, dspicdem, dspicdem.net, dspicworks, dsspeak, ECAN, ECONOMONITOR, FanSense, HI-TIDE, In-Circuit Serial Programming, ICSP, Mindi, MiWi, MPASM, MPF, MPLAB Certified logo, MPLIB, MPLINK, mtouch, Omniscient Code Generation, PICC, PICC-18, PICDEM, PICDEM.net, PICkit, PICtail, REAL ICE, rflab, Select Mode, SQI, Serial Quad I/O, Total Endurance, TSHARC, UniWinDriver, WiperLock, ZENA and Z-Scale are trademarks of Microchip Technology Incorporated in the U.S.A. and other countries. SQTP is a service mark of Microchip Technology Incorporated in the U.S.A. GestIC and ULPP are registered trademarks of Microchip Technology Germany II GmbH & Co. KG, a subsidiary of Microchip Technology Inc., in other countries. All other trademarks mentioned herein are property of their respective companies. 2014, Microchip Technology Incorporated, Printed in the U.S.A., All Rights Reserved. Printed on recycled paper. ISBN: Microchip received ISO/TS-16949:2009 certification for its worldwide headquarters, design and wafer fabrication facilities in Chandler and Tempe, Arizona; Gresham, Oregon and design centers in California and India. The Company s quality system processes and procedures are for its PIC MCUs and dspic DSCs, KEELOQ code hopping devices, Serial EEPROMs, microperipherals, nonvolatile memory and analog products. In addition, Microchip s quality system for the design and manufacture of development systems is ISO 9001:2000 certified. DS A-page Microchip Technology Inc.

3 DALI CONTROL GEAR LIBRARY AND DEMO APPLICATION USER S GUIDE Table of Contents Preface... 5 Introduction... 5 Document Layout... 5 Conventions Used in this Guide... 6 Recommended Reading... 7 The Microchip Web Site... 7 Customer Support... 8 Document Revision History... 8 Chapter 1. Overview 1.1 Introduction DALI Control Gear Hardware Microcontroller Clock Source User Interface DALI Requirements Generating DALI Bit Timings Nonvolatile Memory Chapter 2. DALI Control Gear Library 2.1 Hardware Requirements Specifications DALI Control Gear Library Limitations Structure DALI Control Gear Library Implementation Details Hardware Abstraction Layer DALI Protocol DALI Machine Configuring the library Device Type 6 Compatibility Non-Mandatory Memory Bank Implementation Physical Minimum Level Special Fade Time for DAPC Sequence Additional values for Device Type 6 Devices Chapter 3. DALI Control Gear Application Example 3.1 Introduction DALI Control Gear Application Initialization Application Structure and Data Flow Microchip Technology Inc. DS A-page 3

4 DALI Control Gear Library and Demo Application User s Guide Appendix A. DALI Control Gear Library API A.1 Introduction Worldwide Sales and Service...27 DS A-page Microchip Technology Inc.

5 DALI CONTROL GEAR LIBRARY AND DEMO APPLICATION USER S GUIDE Preface NOTICE TO CUSTOMERS All documentation becomes dated, and this manual is no exception. Microchip tools and documentation are constantly evolving to meet customer needs, so some actual dialogs and/or tool descriptions may differ from those in this document. Please refer to our web site ( to obtain the latest documentation available. Documents are identified with a DS number. This number is located on the bottom of each page, in front of the page number. The numbering convention for the DS number is DSXXXXXA, where XXXXX is the document number and A is the revision level of the document. For the most up-to-date information on development tools, see the MPLAB IDE online help. Select the Help menu, and then Topics to open a list of available online help files. INTRODUCTION DOCUMENT LAYOUT This chapter contains general information that describes the DALI Control Gear Library as well as the DALI Control Gear demo application. Items discussed in this chapter include: Document Layout Conventions Used in this Guide Recommended Reading The Microchip Web Site Customer Support Document Revision History This document describes the structure and the interface of the DALI Control Gear Library as well as the DALI Control Gear demo application. The demo application can easily be modified to be adapted to different hardware. This document covers a detailed description of the application and the library. More information can be found within the source code of the project. The manual layout is as follows: Chapter 1. Overview Chapter 2. DALI Control Gear Library Chapter 3. DALI Control Gear Application Example Appendix A. DALI Control Gear Library API 2014 Microchip Technology Inc. DS A-page 5

6 DALI Control Gear Library and Demo Application User s Guide CONVENTIONS USED IN THIS GUIDE This manual uses the following documentation conventions: DOCUMENTATION CONVENTIONS Description Represents Examples Arial font: Italic characters Referenced books MPLAB IDE User s Guide Emphasized text...is the only compiler... Initial caps A window the Output window A dialog the Settings dialog A menu selection select Enable Programmer Quotes A field name in a window or Save project before build dialog Underlined, italic text with A menu path File>Save right angle bracket Bold characters A dialog button Click OK A tab Click the Power tab N Rnnnn A number in verilog format, 4 b0010, 2 hf1 where N is the total number of digits, R is the radix and n is a digit. Text in angle brackets < > A key on the keyboard Press <Enter>, <F1> Courier New font: Plain Courier New Sample source code #define START Filenames autoexec.bat File paths c:\mcc18\h Keywords _asm, _endasm, static Command-line options -Opa+, -Opa- Bit values 0, 1 Constants 0xFF, A Italic Courier New A variable argument file.o, where file can be any valid filename Square brackets [ ] Optional arguments mcc18 [options] file [options] Curly brackets and pipe Choice of mutually exclusive errorlevel 0 1 character: arguments; an OR selection Ellipses... Replaces repeated text var_name [, var_name...] Represents code supplied by user void main (void)... DS A-page Microchip Technology Inc.

7 Preface RECOMMENDED READING THE MICROCHIP WEB SITE This user s guide describes the structure and the interface of the DALI Control Gear Library as well as the DALI Control Gear demo application. Other useful documents are listed below. The following Microchip documents are available and recommended as supplemental reference resources. Read me Files For the latest information on using other tools, read the tool-specific Readme files in the Readmes subdirectory of the MPLAB X IDE installation directory. The Readme files contain update information and known issues that may not be included in this user s guide. IEC General Requirements Control Gear: This document describes the protocol and methods for testing of DALI devices. IEC Particular Requirements for Control Gear LED Modules (Device Type 6): This document establishes the specific requirements for LED modules (device type 6). Microchip DS : The data sheet for the PIC16F1947 microcontroller which is used in this demo application. Microchip Lighting Resources: DALI AG web site: Microchip provides online support via our web site at This web site is used as a means to make files and information easily available to customers. Accessible by using your favorite Internet browser, the web site contains the following information: Product Support Data sheets and errata, application notes and sample programs, design resources, user s guides and hardware support documents, latest software releases and archived software General Technical Support Frequently Asked Questions (FAQs), technical support requests, online discussion groups, Microchip consultant program member listing Business of Microchip Product selector and ordering guides, latest Microchip press releases, listing of seminars and events, listings of Microchip sales offices, distributors and factory representatives 2014 Microchip Technology Inc. DS A-page 7

8 DALI Control Gear Library and Demo Application User s Guide CUSTOMER SUPPORT Users of Microchip products can receive assistance through several channels: Distributor or Representative Local Sales Office Field Application Engineer (FAE) Technical Support Customers should contact their distributor, representative or field application engineer (FAE) for support. Local sales offices are also available to help customers. A listing of sales offices and locations is included in the back of this document. Technical support is available through the web site at: DOCUMENT REVISION HISTORY Revision A (June 2014) Initial release of this document. DS A-page Microchip Technology Inc.

9 DALI CONTROL GEAR LIBRARY AND DEMO APPLICATION USER S GUIDE Chapter 1. Overview 1.1 INTRODUCTION The DALI Control Gear demo application that relies on the DALI Control Gear Library is designed to run on the Microchip Lighting Communication Main Board (DM160214, see Figure 1-1) with the Microchip DALI Adapter (AC , see Figure 1-2). FIGURE 1-1: LIGHTING COMMUNICATION MAIN BOARD FIGURE 1-2: DALI ADAPTER 2014 Microchip Technology Inc. DS A-page 9

10 DALI Control Gear Library and Demo Application User s Guide 1.2 DALI CONTROL GEAR HARDWARE The Microchip Lighting Communications Main Board s hardware consists of an 8-bit Microchip microcontroller (PIC16F1947), power supply, a current-controlled RGBW LED, an interface port and the user interface elements: a slider, four push buttons and an LCD. The Microchip DALI Adapter, which attaches to the main board s interface port, provides the needed circuitry for interfacing to a DALI bus. The current library and demo application only targets LED modules (Device Type 6), which do not support multiple color channels. Thus, the application uses just the white die available in the RGBW LED package Microcontroller Clock Source The application uses the microcontroller s internal oscillator, configured for 8 MHz and the on-chip 4xPLL, to achieve a system clock of 32 MHz. Although an 8 MHz crystal is available on the Lighting Communications Main Board, the internal oscillator has been used since the DALI bus does not have very strict timing constraints User Interface Since the hardware cannot perform all the measurements required by a fully-featured DALI compliant device, some of the measurements are simulated using button combinations on the Lighting Communications Main Board. In order to keep the application minimal, the on-board LCD and slider on the DALI Control Gear remain unused. The measurements that are simulated can indicate the following Fault conditions. Please note that since switches S2 and S3 perform different functions when used alone or when in combination with S4 or S5, the order in which combinations are pressed is relevant. To simulate Load Increase (S5 + S2), first press S5 and then, keeping S5 pressed, also press S2. TABLE 1-1: SIMULATING FAULT CONDITIONS Pressed Switches Simulated Fault Condition S2 Open Circuit (Lamp disconnected) S3 Short Circuit S4+S2 Thermal Overload S4+S3 Thermal Shutdown S5+S2 Load Increase S5+S3 Load Decrease S5+S4 Disturb reference system power DS A-page Microchip Technology Inc.

11 Overview 1.3 DALI REQUIREMENTS Generating DALI Bit Timings The DALI protocol consists of a Manchester encoded signal at 1200 bps, which defines the half-bit time of 416.6(7) µs. To achieve this DALI half-bit time (TE) of µs, Timer1 is used with its clock source set to FOSC/4 and prescaler 1:4. In this case, the timer incrementing frequency will be 2 MHz. Since an important value that will need to be used is the number of timer ticks that make up a TE, we can find out that: EQUATION 1-1: RELATIONSHIP BETWEEN TIMER FREQUENCY AND DALI HALF-BIT PERIOD (TE) 2 MHz s 833 Timer ticks The symbol TE is defined in dali_cg_hardware.h to have this value, as it is used throughout the library. Since Timer1 is a 16-bit timer, it has no problem accommodating this value. Note: The application will need to also accommodate (within the allowed range of the timer used) values as large as 15 * TE, thus placing boundaries on the timer s clocking sources Nonvolatile Memory The library requires some nonvolatile storage in order to implement the following: Some DALI variables such as short address, fade times, power-on level, etc. Most recent power level used. When configured to do so, the Control Gear needs to be able to retrieve at power-up the most recent power level used Memory in DALI memory banks Although strictly not part of the library, the reference system power measurement also needs to store its result(s) to nonvolatile memory The number of bytes the library requires for the DALI variables needed to be stored in nonvolatile memory is accessible using the DALI_MACHINE_NVMEMORY_REQUIRED symbol defined in dali_cg_machine.h. How memory is implemented in hardware is irrelevant to the library, as the application will access it through calls to nvmem_dalireadbyte(location) and nvmem_daliwritebyte(location, value) which need to be implemented in dali_cg_nvmemory.c along with other functions. The parameter location can take any value from 0 to DALI_MACHINE_NVMEMORY_REQUIRED Microchip Technology Inc. DS A-page 11

12 DALI Control Gear Library and Demo Application User s Guide The most recent power level used needs to be stored under certain control gear configurations. Since this value may be updated often, excessive wear of the nonvolatile medium can occur. In order to allow the application to mitigate this, a dedicated pair of functions is used to implement the storage/retrieval of this value (nvmem_daliwritelastlevel(level) and nvmem_dalireadlastlevel()). As an example of lowering the wear of the nonvolatile memory, the demo application uses a 16-byte circular buffer in the internal EEPROM in order to reduce the usage of each individual EEPROM cell. The PIC16F1947 has a large amount of data memory and could accommodate even larger circular buffers for the task. Note: Other implementations could work even better, for example, the application can use regular RAM for all nonvolatile requirements if the application can detect an imminent power failure. Then the RAM would be copied over to nonvolatile memory only in case of such an imminent power failure. The DALI standard defines memory banks that should be implemented in the control gear and which can be accessed remotely, via the DALI bus. The only mandatory memory bank is Bank 0; the library allows the definition and use of up to eight memory banks; however memory Bank 0 can only be a read-only one. The implementation of the memory banks is irrelevant to the library, as it accesses them through nvmem_dalibankmemoryread(bank, location) and nvmem_dalibankmemorywrite(bank, location, value). The access mechanism required by IEC (using the write-enabled state and the lock bytes for each bank) is handled by the DALI Control Gear Library. DS A-page Microchip Technology Inc.

13 DALI CONTROL GEAR LIBRARY AND DEMO APPLICATION USER S GUIDE Chapter 2. DALI Control Gear Library 2.1 HARDWARE REQUIREMENTS 2.2 SPECIFICATIONS One External interrupt which functions as the receiver pin for the DALI Interface One GPIO pin which functions as the transmitter pin for the DALI Interface One Timer which is used to generate the DALI waveforms when transmitting and to check the waveforms when receiving 1 ms tick that needs to be provided by the application Lamp control mechanism Nonvolatile memory storage Reference system power (optional) The DALI Control Gear Library handles: Communication on the DALI bus (reception of forward frames, transmission of backward frames and detection of communication, timing or bus disconnection errors) DALI specific variables, both RAM-based as well as nonvolatile ones Checking if received forward frames are addressed to the current control device Interpretation of DALI commands and procedures Fading with the requested fade rates or fade times Special answers on the DALI bus at different Fault conditions Memory bank access control (implementing memory locks for writable memory, memory bank checksums) DALI Control Gear Library Limitations The DALI Control Gear Library does not handle any of the following aspects, since these depend on the specific application, the lamp characteristics and the available hardware: Lamp dimming: While the DALI Control Gear Library tells the application how bright the lamp should be, it is the application layer that needs to drive the lamp power to that level, taking into account the lamp characteristics. Turning the lamp off or reducing the power output in case of Fault conditions: The library does reply that the lamp is off when required by the standard, but it does not command the application to turn it off. This should be handled by the application based on lamp hardware implementation. Lamp status: The DALI Control Gear Library needs to be aware of the status of the lamp and the application needs to use the API to periodically update this lamp status within the application. This should be handled by the application based on lamp hardware implementation. Nonvolatile memory: The DALI Control Gear Library uses a number of functions that need to interface to the nonvolatile memory. This is handled by the application layer Microchip Technology Inc. DS A-page 13

14 DALI Control Gear Library and Demo Application User s Guide Reference system power: The DALI Control Gear Library implements the control mechanism for starting/stopping/querying the reference system power measurement, but it is the application which needs to implement it. Note: Implementing the reference system power measurement and the lamp status information are optional; please check IEC and IEC for further details. 2.3 STRUCTURE The DALI Control Gear Library is schematically presented in Figure 2-1, along with the application since the application needs to provide quite an extensive interface to the hardware and the library cannot be completely described out of context. The DALI Control Gear application is layered and modular, built around the core of the library, implemented in dali_cg_layer, dali_cg_machine and dali_cg_protocol. Below is a brief description of each layer: main The application loop keeps the DALI Control Gear Library and the lamp control mechanism synchronized, and also calls dali_tasks() to run the DALI machine. The Interrupt Service Routine branches to the appropriate functions within the DALI system (1 ms tick, External interrupt and TE Timer interrupt) dali_cg_layer - provides the API to the library. It is implemented as a buffer between the core of the library and the user application dali_cg_machine - is the core of the DALI command processing system dali_cg_protocol - implements transmission, reception of data and error detection on the DALI bus dali_cg_hardware - is a hardware abstraction layer that allows users to easily port the library to other PIC microcontrollers Although not an integral part of the library, required functionality needs to be provided by the following functional blocks: random - provides random number generation that is needed during DALI commissioning dali_cg_nvmemory - implements the application-specific nonvolatile memory management. Note: Some of the functions this block provides need to adhere to some restrictions since these are called from the core of the DALI Control Gear Library. The lighting hardware is grouped in two more functional blocks: lamp_hardware - implements the lamp management functionality, such as setting power levels using the required dimming curve and also provides data for the lamp status lamp_reference_system_power - groups functionality required by the implementation of any reference system power measurement DS A-page Microchip Technology Inc.

15 2014 Microchip Technology Inc. DS A-page 15 FIGURE 2-1: while(1) dali_tasks(); lamp_setpower(dali_getpower()); dali_setstatus(lamp_getstatus()); LED Dimming CCP Timer DALI CONTROL GEAR DEMO APPLICATION ARCHITECTURE lamp_reference_system_power lamp_setpower() lamp_getstatus() lamp_hardware lamp_getoperatingmode() Buttons GPIO DALI Control Gear stack and application lamprefsyspower_start() lamprefsyspower_stop() lamprefsyspower_getstatus() lamprefsyspower_tick1ms() Buttons GPIO Reference System Power nvmem_refsyspowerwritebyte() nvmem_refsyspowerreadbyte() Bank Memory main nvmem_dalibankmemorywrite() nvmem_dalibankmemoryread() Function call Shared data dali_getflags() dali_setreferencesystempowerstatus() Non-Volatile Memory nvmem_dalireadbyte() nvmem_daliwritebyte() nvmem_daliwritelastlevel() nvmem_dalireadlastlevel() dali_cg_nvmemory dali_tasks() NV Memory EEPROM Code dali_cg_layer Reference System Power idali_startreferencesystempower() idali_stopreferencesystempower() idali_getstatusreferencesystempower() dali_tasks() Functionality group random_byte() random dali_cg_machine MCU Hardware dali_getpower() dali_setstatus() dali_setoperatingmode() dalihw_isdalilinelow() idali_sendbackwardframe() dali_cg_hardware Hardware configuration Hardware Feedback/readout dali_cg_protocol Lamp Status and Control idali_startidentificationprocedure() idali_setlamppower() idali_getlampstatus() idali_getlampoperatingmode() ISR() idali_receiveforwardframe() frame data Timer dali_tick1ms() idali_tick1msmachine() dali_interrupttetimer() DALI Communication Ext. Interrupt dali_interruptexternal() GPIO 1ms tick Timer DALI Control Gear Library

16 DALI Control Gear Library and Demo Application User s Guide 2.4 DALI CONTROL GEAR LIBRARY IMPLEMENTATION DETAILS This section gives details on the different layers of the library. For further information, please check the comments in the relevant source code files Hardware Abstraction Layer The library depends heavily on a small number of peripherals to implement the DALI protocol. In order to make it as portable as possible, the hardware interface is separated from the rest of the code. The flexibility provided by this layer, along with the small number of peripherals should allow for seamless adaptation of the library to new architectures DALI Protocol The DALI Control Gear Library does not use any specific hardware to implement its communication layer (Manchester decoding/encoding), in order to be easily portable to most Microchip PIC microcontrollers. The library uses a state machine driven by the external interrupt and a timer for both reception and transmission of bits using the DALI bus, as well as for bit and framing error detection and making sure the inter-frame timings defined by IEC are respected. This communication layer is isolated in its own file having a simple interface to dali_cg_machine. If necessary, it can easily be replaced by a hardware-optimized version. While no data transfer is taking place, the protocol state machine keeps the external interrupt on the receive pin armed. Once this interrupt is triggered, the timer in conjunction with this external interrupt are used both for checking the correct format of the bits that are being received as well as for detecting a time-out which would signal an error. Figure 2-2 shows the waveform corresponding to the command BROADCAST DIRECT ARC POWER CONTROL 58, where the individual bit times (2 TE) are delimited by dotted lines. FIGURE 2-2: WAVEFORM ON THE DALI BUS THAT TRANSMITS THE BROADCAST DIRECT ARC POWER CONTROL 58 COMMAND DS A-page Microchip Technology Inc.

17 DALI Control Gear Library The library checks for the correct timings for the pulses and Stop bits and discards the frame if it is found to be malformed. The acceptable timings for valid pulse widths within a frame (1 TE or 2 TE) are derived from the TE value which is set in the demo application to µs. The received pulse width is checked against the following values: 1 TE if pulse width in [ µs, µs] 2 TE if pulse width in [583.1 µs, µs]. When required to transmit data, the library generates the bit timings using the same timer DALI Machine 2.5 CONFIGURING THE LIBRARY The core of the DALI Control Gear Library has three main entry points after initialization: Forward frame reception (from the protocol layer, called from the interrupt). Since the interrupt routine is rather lengthy (it has to decode/encode the Manchester signal), the data received from the bus is stored during forward frame reception in a variable and is accessed by the state machine s run function whenever it is run by the mainline code. 1 ms tick (from the interrupt) which is required by the fading mechanism and by various software timers that the DALI standard requires to be implemented (such as the time between cable disconnection and going to the system failure level if it s programmed to do so). State machine run function, dali_tasks(), called as often as possible by its main application loop. This function processes any new data received from the bus, checks the system parameters and updates its internal flags accordingly. Apart from these, the library exposes a number of functions which need to be used to update the library s copies of lamp status variables and to provide the library commands that the application should execute. This state machine also implements the DALI specific mechanisms, such as handling the commissioning process, nonvolatile memory access, etc. Parameters for the DALI Control Gear Library are placed in dali/dali_cg_config.h. The DALI Control Gear Library can have some of its functionality enabled or disabled according to the user requirements. Disabling some functionality removes some of the code, thus resulting in a smaller binary. The features that can be disabled are: Device Type 6 (LED) compatibility Non-mandatory memory bank implementation Device Type 6 Compatibility The DALI standard defines multiple device types, of which type number six represents LED lamps. Supporting a specific device type requires device special commands to be implemented. Device Type 6 compatibility is enabled by defining the symbol: DALI_USE_DEVICE_TYPE_6. Note: The Control Gear needs to support at least one device type, thus this may require library modifications in order to remain DALI compliant Microchip Technology Inc. DS A-page 17

18 DALI Control Gear Library and Demo Application User s Guide Non-Mandatory Memory Bank Implementation The DALI documentation defines memory banks that can be accessed remotely by the control device. The DALI Control Gear Library implements Bank 0 as a read-only bank, which is required by the standard irrespective of this setting. Enabling this setting allows the user to implement other banks which can also be written. Implementing these banks can be done by the user in the nonvolatile memory layer. This functionality is enabled by defining the symbol DALI_USE_EXTRA_MEMORY_BANKS. Note: The DALI memory banks are not related to the Microchip PIC device memory banks. The former are described in detail in IEC , section 9.8, whereas the latter in the microcontroller s data sheets Physical Minimum Level The PHYSICAL_MINIMUM_LEVEL symbol is the minimum output power that the lamp can produce and should hold a value between 1 and 254 (inclusive). Details on the physical minimum level can be found in IEC Note: A non-dimmable DALI device can be built by setting PHYSICAL_MINIMUM_LEVEL to Special Fade Time for DAPC Sequence During a DAPC sequence, the programmed fade time shall be replaced by a special fade time, greater than or equal to 200 ms. The DAPC_SEQUENCE_FADE_TIME_MS symbol defines that special fade time. Although this value is expressed in milliseconds, within the library it has a granularity of 5 ms. Details on the DAPC sequence mechanism can be found in IEC , section , Command 9. DS A-page Microchip Technology Inc.

19 DALI Control Gear Library Additional values for Device Type 6 Devices If Device Type 6 compatibility is required, four more values need to be defined: GEAR_TYPE: Control Gear parameters. Please see IEC , section , Command 237 for further details. MIN_FAST_FADE_TIME: Please see IEC , section 9.13 for details on the fast fade time. The valid range for this value is between 1 and 27 (inclusive). POSSIBLE_OPERATING_MODES: Please see IEC , section , Command 239 for further details on operating modes. FEATURES: Please see IEC , section , Command 240 for further details on operating the FEATURES byte. Note: GEAR_TYPE, POSSIBLE_OPERATING_MODES and FEATURES parameters should reflect the functionality implemented by the application, as no checks are made by the library in this respect Microchip Technology Inc. DS A-page 19

20 DALI CONTROL GEAR LIBRARY AND DEMO APPLICATION USER S GUIDE Chapter 3. DALI Control Gear Application Example 3.1 INTRODUCTION The provided API places the DALI Control Gear Library under the control of the application. The user application needs to make sure that the values in the library are updated periodically, by calling the appropriate functions often. Similarly, the application should check if the lamp power needs to be updated and do so. Minimum update rate should be fast enough to keep up with lamp fade characteristics. 3.2 DALI CONTROL GEAR APPLICATION INITIALIZATION The library initialization resets the internal state machines. The application hardware has a separate initializer such that the user can choose to merge this with the rest of the application s hardware initialization. In the case of the demo application, the initialization calls are shown in Example 3-1. EXAMPLE 3-1: INITIALIZATION CALLS FOR THE DEMO APPLICATION // define a variable of flags that will be used to obtain status from the library tdali_flags_cg dalicgflags; // clear all flags dalicgflags.all = 0; // code that configures the system clock [...] // code that configures a timer to generate a 1ms tick [...] // not part of the library, initialize random number generator random_init(); // initialise DALI communication hardware dalihw_init(); // not part of the library, initialize lamp hardware lamp_init(); // not part of the library, initialise lamp reference system power lamprefsyspower_init(); // obtain physical minimum level for the non-logarithmic dimming curve such that // the library can align the two minima dali_setnonlogphysicalminimum(lamp_getdimmingtablevalue(physical_minimum_level)); // initialise DALI library dali_init(); // enable interrupts ei(); while(1) [...] DS A-page Microchip Technology Inc.

21 2014 Microchip Technology Inc. DS A-page 21 FIGURE 3-1: while(1) dali_tasks(); lamp_setpower(dali_getpower()); dali_setstatus(lamp_getstatus()); LED Dimming CCP Timer LAMP DIMMING AND LAMP STATUS DATA FLOW THROUGH THE DALI APPLICATION lamp_reference_system_power lamp_setpower() lamp_getstatus() lamp_hardware lamp_getoperatingmode() Buttons GPIO DALI Control Gear stack and application lamprefsyspower_start() lamprefsyspower_stop() lamprefsyspower_getstatus() lamprefsyspower_tick1ms() Buttons GPIO Reference System Power nvmem_refsyspowerwritebyte() nvmem_refsyspowerreadbyte() Bank Memory main nvmem_dalibankmemorywrite() nvmem_dalibankmemoryread() Function call Shared data Library sets lamp power Library obtains lamp status dali_getflags() dali_setreferencesystempowerstatus() Non-Volatile Memory nvmem_dalireadbyte() nvmem_daliwritebyte() nvmem_daliwritelastlevel() nvmem_dalireadlastlevel() dali_cg_nvmemory dali_tasks() NV Memory EEPROM Code dali_cg_layer Reference System Power idali_startreferencesystempower() idali_stopreferencesystempower() idali_getstatusreferencesystempower() dali_tasks() Functionality group random_byte() random dali_cg_machine MCU Hardware dali_getpower() dali_setstatus() dali_setoperatingmode() dalihw_isdalilinelow() idali_sendbackwardframe() dali_cg_hardware Hardware configuration Hardware Feedback/readout dali_cg_protocol Lamp Status and Control idali_startidentificationprocedure() idali_setlamppower() idali_getlampstatus() idali_getlampoperatingmode() ISR() idali_receiveforwardframe() frame data Timer dali_tick1ms() idali_tick1msmachine() dali_interrupttetimer() DALI Communication Ext. Interrupt dali_interruptexternal() GPIO 1ms tick Timer DALI Control Gear Library and Demo Application User s Guide

22 DALI Control Gear Library and Demo Application User s Guide 3.3 APPLICATION STRUCTURE AND DATA FLOW The application structure presented earlier in Figure 2-1 is also visible in Figure 3-1, with two added lines that emphasize the data flow for the lamp power (red) from the DALI Control Gear Library to the lamp hardware and the lamp status (blue) the other way around. All data transfers are handled by the main program loop, such that the user is in total control of both library and lamp hardware. The main loop should periodically query the library flags as these carry important information regarding lamp actions that may need to be taken. During the application execution there are two entry points into the library, the main loop and the interrupts. The main loop is outlined below and keeps polling the library for work and does it if required while also continuously informing the library of the lamp status. The interrupts handle DALI bus communication and the 1 millisecond tick. EXAMPLE 3-2: while(1) // run the DALI state machine dali_tasks(); MAIN APPLICATION LOOP, HANDLING THE COMMUNICATION TO THE DALI LIBRARY // ask the library if it wants us to do any work dalicgflags.all = dali_getflags(); // tell the library the lamp status dali_setstatus(lamp_getstatus()); // if the library wants us to start the identification procedure, do it // and clear the associated flag if (dalicgflags.startidentificationprocedure == 1) lamp_setpower(254, 0); dalicgflags.startidentificationprocedure = 0; // if the library wants us to update the lamp power, do it and clear the // flags if (dalicgflags.updatedlamppower == 1) lamp_setpower(dali_getpower(), dalicgflags.nonlogdimming); dalicgflags.updatedlamppower = 0; dalicgflags.nonlogdimming = 0; // tell the library the lamp operating mode dali_setoperatingmode(lamp_getoperatingmode()); // tell the library the lamp s reference system power status dali_setreferencesystempowerstatus(lamprefsyspower_getstatus()); // if the library wants us to start a reference system power do it and // clear the flag if (dalicgflags.startreferencesystempower == 1) lamprefsyspower_start(); dalicgflags.startreferencesystempower = 0; DS A-page Microchip Technology Inc.

23 DALI Control Gear Application Example EXAMPLE 3-3: MAIN APPLICATION LOOP, HANDLING THE COMMUNICATION TO THE DALI LIBRARY (CONTINUED) // if the library wants us to stop any running reference system power // do that and clear the flag if (dalicgflags.stopreferencesystempower == 1) lamprefsyspower_stop(); dalicgflags.stopreferencesystempower = 0; // check if one millisecond has passed. If so, run the corresponding // tick function for the reference system power and clear the flag if (dalicgflags.tick1ms == 1) lamprefsyspower_tick1ms(); dalicgflags.tick1ms = 0; The demo application uses a PIC16F1947 which has a single interrupt vector. Different interrupt sources are handled by checking within the interrupt code for the signal that triggered it. Below is the code that handles the three interrupts needed in the demo application. The 1 ms tick is needed by the DALI application for time-keeping reasons (and is also used by the reference system power mechanism for the same purpose). The external interrupt and TE Timer interrupt handle communication on the DALI bus. EXAMPLE 3-4: INTERRUPT SERVICE ROUTINE FOR THE DALI COMMUNICATION AND 1 MS TICK void interrupt ISR() // 1ms tick interrupt. This application uses Timer 4 for this reason. // The lack of abstraction for this timer is due to the fact that // it is only initialised once in main() and used once, here if ((TMR4IF!= 0) && (TMR4IE!= 0)) TMR4IF = 0; dali_tick1ms(); // Te Timer interrupt. The Te Timer is fully abstracted since it is // heavily used within the library if (dalihw_tetimerinterrupttriggered()) dalihw_tetimerclearinterrupt(); dali_interrupttetimer(); // External interrupt if ((INTF!= 0) && (INTE!= 0)) INTF = 0; dali_interruptexternal(); 2014 Microchip Technology Inc. DS A-page 23

24 DALI CONTROL GEAR LIBRARY AND DEMO APPLICATION USER S GUIDE Appendix A. DALI Control Gear Library API A.1 INTRODUCTION Below is a brief description of the functions that the DALI Control Gear Library provides. These are available after the inclusion of dali_cg.h. TABLE A-1: API FUNCTIONS AND CODE EXAMPLES FOR THE DALI CONTROL GEAR LIBRARY Declaration and Description Code example void dalihw_init () DALI communication hardware configuration. void dalihw_tetimerclearinterrupt () Clear TE Timer interrupt flag. uint8_t dalihw_tetimerinterrupttriggered () Check if the TE Timer interrupt triggered. void dali_interrupttetimer () API Call: The application should call this function for every TE Timer interrupt. void dali_interruptexternal () API Call: The application should call this function for every external interrupt. void dali_init () API Call: Initialise the DALI library void dali_tasks () API Call: Run one iteration of the DALI state machine which, among others, checks if any new DALI frame has arrived and if so, processes it void dali_tick1ms () API Call: Library code that should be run every millisecond dalihw_init(); // Initialise the hardware (Te // Timer, External interrupt, // pin tristate and latch // registers) void interrupt ISR() [...] if (dalihw_tetimerinterrupttriggered()) dalihw_tetimerclearinterrupt(); dali_interrupttetimer(); [...] void interrupt ISR() [...] if (dalihw_tetimerinterrupttriggered()) dalihw_tetimerclearinterrupt(); dali_interrupttetimer(); [...] void interrupt ISR() [...] if (dalihw_tetimerinterrupttriggered()) dalihw_tetimerclearinterrupt(); dali_interrupttetimer(); [...] void interrupt ISR() [...] if ((INTF!= 0) && (INTE!= 0)) INTF = 0; dali_interruptexternal(); [...] dali_init(); // Initialise DALI Library while(1) dali_tasks(); // Call DALI Library code [...] // Handle other application // aspects void interrupt ISR() if ((TMR4IF!= 0) && (TMR4IE!= 0)) TMR4IF = 0; dali_tick1ms(); DS A-page Microchip Technology Inc.

25 DALI Control Gear Library API TABLE A-1: uint8_t dali_getflags () API Call: Obtain the DALI library flags API FUNCTIONS AND CODE EXAMPLES FOR THE DALI CONTROL GEAR LIBRARY Declaration and Description uint8_t dali_getpower () API Call: Obtain the power that the application should command the lamp to go to void dali_setstatus (uint8_t status) API Call: Inform the library of the lamp status void dali_setoperatingmode (uint8_t mode) API Call: Inform the library of the lamp operating mode void dali_setnonlogphysicalminimum (uint8_t level) API Call: Inform the library of the non-logarithmic physical minimum level void dali_setreferencesystempowerstatus (uint8_t status) API Call: Inform the library of the reference system power status Code example dalicgflags.all = dali_getflags(); [...] // Check flags and clear them after usage if (dalicgflags.updatedlamppower == 1) lamp_setpower(dali_getpower(), dalicgflags.nonlogdimming); dalicgflags.updatedlamppower = 0; dalicgflags.nonlogdimming = 0; // Obtain the status from the lamp and send // it to the library dali_setstatus(lamp_getstatus()); // Obtain the lamp operating mode and send it // to the library dali_setoperatingmode(lamp_getoperatingmode()); // During initialisation, pass the // non-logarithmic value of the physical // minimum level to the library dali_setnonlogphysicalminimum( lamp_getdimmingtablevalue( PHYSICAL_MINIMUM_LEVEL)); // Obtain the status of the reference system // power and send it to the library dali_setreferencesystempowerstatus( lamprefsyspower_getstatus()); 2014 Microchip Technology Inc. DS A-page 25

26 DALI Control Gear Library and Demo Application User s Guide NOTES: DS A-page Microchip Technology Inc.

27 Worldwide Sales and Service AMERICAS Corporate Office 2355 West Chandler Blvd. Chandler, AZ Tel: Fax: Technical Support: support Web Address: Atlanta Duluth, GA Tel: Fax: Austin, TX Tel: Boston Westborough, MA Tel: Fax: Chicago Itasca, IL Tel: Fax: Cleveland Independence, OH Tel: Fax: Dallas Addison, TX Tel: Fax: Detroit Novi, MI Tel: Houston, TX Tel: Indianapolis Noblesville, IN Tel: Fax: Los Angeles Mission Viejo, CA Tel: Fax: New York, NY Tel: San Jose, CA Tel: Canada - Toronto Tel: Fax: ASIA/PACIFIC Asia Pacific Office Suites , 37th Floor Tower 6, The Gateway Harbour City, Kowloon Hong Kong Tel: Fax: Australia - Sydney Tel: Fax: China - Beijing Tel: Fax: China - Chengdu Tel: Fax: China - Chongqing Tel: Fax: China - Hangzhou Tel: Fax: China - Hong Kong SAR Tel: Fax: China - Nanjing Tel: Fax: China - Qingdao Tel: Fax: China - Shanghai Tel: Fax: China - Shenyang Tel: Fax: China - Shenzhen Tel: Fax: China - Wuhan Tel: Fax: China - Xian Tel: Fax: China - Xiamen Tel: Fax: China - Zhuhai Tel: Fax: ASIA/PACIFIC India - Bangalore Tel: Fax: India - New Delhi Tel: Fax: India - Pune Tel: Japan - Osaka Tel: Fax: Japan - Tokyo Tel: Fax: Korea - Daegu Tel: Fax: Korea - Seoul Tel: Fax: or Malaysia - Kuala Lumpur Tel: Fax: Malaysia - Penang Tel: Fax: Philippines - Manila Tel: Fax: Singapore Tel: Fax: Taiwan - Hsin Chu Tel: Fax: Taiwan - Kaohsiung Tel: Taiwan - Taipei Tel: Fax: Thailand - Bangkok Tel: Fax: EUROPE Austria - Wels Tel: Fax: Denmark - Copenhagen Tel: Fax: France - Paris Tel: Fax: Germany - Dusseldorf Tel: Germany - Munich Tel: Fax: Germany - Pforzheim Tel: Italy - Milan Tel: Fax: Italy - Venice Tel: Netherlands - Drunen Tel: Fax: Poland - Warsaw Tel: Spain - Madrid Tel: Fax: Sweden - Stockholm Tel: UK - Wokingham Tel: Fax: /25/ Microchip Technology Inc. DS A-page 27