Echelon Neuron C Manuel d'utilisateur

0 7 8 - 0 1 4 0 -02F®Neuron®C Reference Guide

x delay( ) Function... 78 Syntax ...

80 Functions Example #pragma relaxed_casting_on eeprom far unsigned int widget[100]; far unsigned int ram_buf[100];

Neuron C Reference Guide 81 associated with the functional block specified, passes the cmd parameter on to that director function, and return

82 Functions void fl_neg (const float_type *arg1, float_type *arg2); void fl_rand (float_type *arg1); void fl_round (

Neuron C Reference Guide 83 when (flush_completes) { // Go to sleep nothing_to_do = FALSE; sleep(); } flush_cancel( ) Function The

84 Functions when (...) { msg_out.tag = TAG1; msg_out.code = 3; msg_send(); flush_wait(); nvoVoltag

Neuron C Reference Guide 85 get_fblock_count( ) Built-in Function The get_fblock_count( ) built-in function is a compiler special function

86 Functions Example void f(void) { unsigned int start, delta; start = get_tick_count(); ... delta = get_tick

Neuron C Reference Guide 87 go_unconfigured( ) Function The go_unconfigured( ) function puts the device into an unconfigured state. It als

88 Functions provided by Series 5000 devices, and is only available to an application that defines at least one inter

Neuron C Reference Guide 89 io_change_init( ) Built-in Function The io_change_init( ) built-in function initializes the I/O object for the

Neuron C Reference Guide xi Syntax ... 90 Example

90 Functions value A value between 1 and 65535 defining the maximum value for each period measurement. Example IO_4

Neuron C Reference Guide 91 For Series 5000 devices, the io_idis( ) function disables all application interrupts. This function does not aff

92 Functions dualslope input unsigned long edgelog input unsigned short i2c unsigned short infrared input unsigne

Neuron C Reference Guide 93 io_in (input-obj); The type of the return-value of the io_in( ) call is listed in the table above. bitshift For b

94 Functions The io_in( ) call has an unsigned short return-value that is the actual number of bits read. magcard For

Neuron C Reference Guide 95 The io_in( ) call has an unsigned short return-value signifying the number of bits actually transferred for a neu

96 Functions Example IO_0 input bit d0; boolean value; ... void f(void) { value = io_in(d0); } io_in_request( ) B

Neuron C Reference Guide 97 io_out( ) Built-in Function The io_out( ) built-in function writes data to an I/O object. The <io_types.h>

98 Functions output-io-object-name Specifies the I/O object name, which corresponds to io-object-name in the I/O dec

Neuron C Reference Guide 99 model in the I/O Model Reference for a detailed explanation of this restriction. muxbus For muxbus I/O objects, t

xii Syntax ... 108 Example ...

100 Functions touch For touch I/O objects, the syntax is: io_out (touch-io-obj, buf, count); buf A (void *) pointer t

Neuron C Reference Guide 101 io_preserve_input( ) Built-in Function The io_preserve_input( ) built-in function is used with an input timer/

102 Functions infrared ontime period pulsecount totalcount clock-value Specifies an optional clock value, in the r

Neuron C Reference Guide 103 { io_set_baud(iosci, SCI_38400); // Optional baud change } io_set_clock( ) Built-in Function The io_set_clo

104 Functions cannot specify TCCLK_40MHz or TCCLK_20MHz – no error is issued, but the effective value used in this ca

Neuron C Reference Guide 105 Example IO_0 output bit b0; IO_0 input byte byte0; int read_byte; void f(void) { io_set_direction(b0, IO_DIR_O

106 Functions } when (...) { io_out(ioTriac, 0); // full off } is_bound( ) Built-in Function The is_bound(

Neuron C Reference Guide 107 low_byte( ) Built-in Function The low_byte( ) built-in function extracts the lower single-byte value from the

108 Functions Table 30. Result Types for the max() Function Larger Type Smaller Type Result unsigned long (any) un

Neuron C Reference Guide 109 Example #include <mem.h> unsigned array1[40]; void f(void) { // Copy up to 40 bytes to array1, // b

Neuron C Reference Guide xiii nv_table_index( ) Built-in Function ... 118 Syntax ...

110 Functions Syntax #include <mem.h> int memcmp (void *buf1, const void *buf2, unsigned long len); Example #in

Neuron C Reference Guide 111 Syntax void memset (void *p, int c, unsigned long len); Example unsigned target[20]; void f(void) { memset(ta

112 Functions when (io_changes(io_push_button)) { msec_delay(10); // Delay 10ms at any clock rate debounced_bu

Neuron C Reference Guide 113 } } msg_cancel( ) Built-in Function The msg_cancel( ) built-in function cancels the message currently being b

114 Functions } ... } msg_receive( ) Built-in Function The msg_receive( ) built-in function receives a message i

Neuron C Reference Guide 115 Example msg_tag motor; # define MOTOR_ON 0 # define ON_FULL 1 when (io_changes(switch1)to ON) { // Send a mes

116 Functions always use muldiv24() without loss of precision, compared to muldiv(), if neither A nor B ever exceeds

Neuron C Reference Guide 117 muldivs( ) Function The muldivs( ) function permits the computation of (A*B)/C where A, B, and C are all 16-bi

118 Functions { application_restart(); } nv_table_index( ) Built-in Function The nv_table_index( ) built-in fun

Neuron C Reference Guide 119 ... if (offline){ // Perform offline cleanup ... offline_confirm(); } } poll( ) Built-in Function T

xiv Syntax ... 129 Example ...

120 Functions when (nv_update_occurs(nviZone)) { // New value of nviZone arrived } post_events( ) Function The

Neuron C Reference Guide 121 if (power_up()) initialize_hardware(); else { // hardware already initialized ... }

122 Functions device interface (XIF) file. Thus, network tools can handle the network address assignment for the var

Neuron C Reference Guide 123 Example void f(void) { unsigned value; ... value = random(); } resp_alloc( ) Built-in Function The resp_al

124 Functions if (offline()) { // Requested to go offline resp_cancel(); } else { r

Neuron C Reference Guide 125 Example void f(void) { ... if (resp_receive()) { // Process message ... resp_free();

126 Functions unsigned long status_rcv_transaction_full; unsigned long status_lost_msgs; unsigned long st

Neuron C Reference Guide 127 status_version_number The version number, which reflects the Neuron firmware version. status_error_log The most

128 Functions value = reverse(value); // now value is 0xC7 } rotate_long_left( ) Function The rotate_long_left(

Neuron C Reference Guide 129 // k now contains 0x87E0 } rotate_short_left( ) Function The rotate_short_left( ) function returns the bit-

Neuron C Reference Guide xv Example ... 140 strncmp( )

130 Functions } scaled_delay( ) Function The scaled_delay( ) function generates a delay that scales with the input

Neuron C Reference Guide 131 void f(void) { io_out(software_one_shot, 1); //turn it on scaled_delay(4); //approx. 108 µsec at 1

132 Functions } } service_pin_msg_send( ) Function The service_pin_msg_send( ) function attempts to send a servic

Neuron C Reference Guide 133 when (timer_expires(three_sec_timer)) { if (service_pin_state()) { // Service pin still depressed // g

134 Functions The function enables or disables the lock (with a TRUE or FALSE argument, respectively). The EEPROM l

Neuron C Reference Guide 135 void s32_ge (const s32_type *arg1, const s32_type *arg2); void s32_gt (const s32_type *arg1, const s32_type *arg

136 Functions void sleep (unsigned int flags , io-object-name); void sleep (unsigned int flags , io-pin); flags One

Neuron C Reference Guide 137 spi_get_error( ) Function The spi_get_error( ) built-in function returns a cumulative OR of the bits shown bel

138 Functions strchr( ) Function The strchr( ) function searches the string s for the first occurrence of the chara

Neuron C Reference Guide 139 { int val; char s1[20], s2[20]; val = strcmp(s1, s2); if (!val) { // Strings are equal } else if (

xvi Syntax ... 152 Example ...

140 Functions Syntax #include <string.h> unsigned long strlen (const char *s); Example #include <string.h>

Neuron C Reference Guide 141 When a mismatch occurs, the characters from both strings at the mismatch are compared. If the first string’s ch

142 Functions Example #include <string.h> char s[20]; void f(char *p) { strncpy(s, p, 19); // Prevent over

Neuron C Reference Guide 143 Example long k; void f(void) { k = 0x1234L; k = swap_bytes(k); // k now contains 0x3412L } timers_off( )

144 Functions touch_byte( ) Built-in Function The touch_byte( ) function sequentially writes and reads eight bits o

Neuron C Reference Guide 145 ... dataOut = 42; touch_byte_spu(1WIREPIN, dataOut); } touch_first( ) Built-in Function The touch_first( )

146 Functions touch_next( ) Built-in Function The touch_next( ) function executes the ROM Search algorithm as descr

Neuron C Reference Guide 147 touch_read_spu( ) Built-in Function This function applies to 1-Wire bus devices that require the bus to be act

148 Functions The touch_reset( ) function does not return until the end of the presence pulse has been detected. Synt

Neuron C Reference Guide 149 { ... int rc; rc = touch_reset_spu(1WIREPIN); } touch_write_spu( ) Built-in Function This function app

Neuron C Reference Guide xvii cp_template_file_len Variable ... 193 fblock_index_map

150 Functions that are all similar, a bit array can be more code-efficient than a series of bitfields because the arr

Neuron C Reference Guide 151 void f(void) { address_copy = *access_address( addr_table_index(my_mt)); // Modify the address_copy her

152 Functions domain/subnet/node address on the network. Typically, cloned devices are intended for low-end systems

Neuron C Reference Guide 153 See the ISO/IEC 14908 (ANSI/EIA/CEA-709.1) Control Network Specification for a description of the data structure

154 Functions } update_nv( ) Function The update_nv( ) function copies from the structure referenced by the nv-entr

Neuron C Reference Guide 155 Syntax #include <access.h> void update_program_id (unsigned char * pid_p); Example #include <access.h&g

Neuron C Reference Guide 157 4 Timer Declarations This chapter provides reference information for declaring and using Neuron C timers. N

158 Timer Declarations Timer Object A timer object is declared using one of the following: mtimer [repeating] timer-n

Neuron C Reference Guide 159 5 Network Variable, Configuration Property, and Message Tag Declarations This chapter describes the network v

160 Network Variable, Configuration Property, and Message Tag Declarations Introduction The external application inte

Neuron C Reference Guide 161 Network Variable Declarations Syntax The complete syntax for declaring a network variable is one of the followin

162 Network Variable, Configuration Property, and Message Tag Declarations sd_string ( concatenated-string-constant )

Neuron C Reference Guide 163 connections can still cause changes to such a configuration network variable. eeprom The network variable is pl

164 Network Variable, Configuration Property, and Message Tag Declarations [signed] long [int] unsigned long [int] s

Neuron C Reference Guide 165 property-reference-list : property-reference-list , property-reference property-reference property-reference : p

166 Network Variable, Configuration Property, and Message Tag Declarations page 171. A range-modification string pro

Neuron C Reference Guide 167 network output SNVT_lev_percent nvoValue[4] nv_properties { static cpMaxSendT // MUST be shared }; Network Va

168 Network Variable, Configuration Property, and Message Tag Declarations ackd (the default) — acknowledged servi

Neuron C Reference Guide 169 priority | nonpriority [( config | nonconfig )] Specifies whether a network variable update has priority acces

Neuron C Reference Guide xix Neuron C Overview Neuron C is a programming language based on ANSI C that is designed for Neuron Chips and Smart

170 Network Variable, Configuration Property, and Message Tag Declarations Configuration Property Declarations You c

Neuron C Reference Guide 171 the NodeBuilder tool. There could be many similar resource files containing UCPT definitions, and these are man

172 Network Variable, Configuration Property, and Message Tag Declarations cp-option-list : cp-option-list , cp-optio

Neuron C Reference Guide 173 point numbers delimited by a colon. The first number is the lower limit and the second number is the high limit

174 Network Variable, Configuration Property, and Message Tag Declarations device_properties { property-reference-lis

Neuron C Reference Guide 175 page 171. A range-modification string provided in the instantiation of a CP family member overrides any range-m

176 Network Variable, Configuration Property, and Message Tag Declarations }; void f(void) { ... if (nvoValue::cp

Neuron C Reference Guide 177 A message tag declaration can optionally include connection information. The syntax for declaring a message tag

Neuron C Reference Guide 179 6 Functional Block Declarations This chapter provides reference information for functional block declarations

Echelon, LONWORKS, LONMARK, NodeBuilder, LonTalk, Neuron, 3120, 3150, ShortStack, LonMaker, and the Echelon logo are trademarks of Echelon Corporation

xx Predefined Events whereas the messaging service is not standardized with the exception of its usage by the LONWORKS file transfer protocol (LW-FT

180 Functional Block Declarations Introduction The external application interface of a LONWORKS device consists of it

Neuron C Reference Guide 181 ext-name : external_name ( C-string-const ) external_resource_name ( C-string-const ) external_resource_nam

182 Functional Block Declarations A Neuron C program can also implement additional network variables in the functiona

Neuron C Reference Guide 183 the external_name string described above. In this case, the device interface information contains a scope and i

184 Functional Block Declarations The functional block property list begins with the fb_properties keyword. It then

Neuron C Reference Guide 185 fb_properties { cpOffset, // offset for each fblock static cpGain, // gain shared in MyFb1 glob

186 Functional Block Declarations the program. The array entry is an unsigned short. Its declaration, in the <ec

Neuron C Reference Guide 187 Just like for network variable properties, even though a configuration network variable can be uniquely accessed

Neuron C Reference Guide 189 7 Built-In Variables, Objects, Symbols, and Semaphore This chapter provides reference information about the b

Neuron C Reference Guide 1 1 Predefined Events This chapter provides reference information on predefined events. The predefined events desc

190 Built-In Variables, Objects, Symbols, and Semaphore Introduction Neuron C Version 2 provides built-in variables a

Neuron C Reference Guide 191 Built-In Variables The following sections list the Neuron C built-in variables alphabetically, providing relevan

192 Built-In Variables, Objects, Symbols, and Semaphore unsigned input_clock : 3; unsigned comm_type

Neuron C Reference Guide 193 cp_readonly_value_file_len Variable The cp_readonly_value_file_len variable contains the length of the cp_read

194 Built-In Variables, Objects, Symbols, and Semaphore Example 1: signed long switch_state; when (io_changes(switch

Neuron C Reference Guide 195 When an nv_update_occurs event is TRUE, the nv_in_addr variable is set to contain the LONWORKS addressing inform

196 Built-In Variables, Objects, Symbols, and Semaphore nv_in_index Variable The nv_in_index variable contains the

Neuron C Reference Guide 197 unsigned : 0; unsigned : 4; unsigned receive_trans_count : 4; unsig

198 Built-In Variables, Objects, Symbols, and Semaphore Built-In Objects The following sections list the Neuron C bui

Neuron C Reference Guide 199 struct { boolean priority_on; msg_tag tag; int code; int data[MAXDATA]; bo

2 Predefined Events Introduction to Predefined Events An event is a programmatic notification provided by the Neuron firmware that there has been an

200 Built-In Variables, Objects, Symbols, and Semaphore resp_out Object The resp_out object contains an outgoing re

Neuron C Reference Guide 201 Symbol Description _NCC5 Defined for version 5 of the Neuron C compiler. This version corresponds to Version

202 Built-In Variables, Objects, Symbols, and Semaphore __lock { // acquire semaphore f(); } // re

Neuron C Reference Guide 203 A Syntax Summary This appendix provides a summary of Neuron C Version 2.2 syntax, with some explanatory materia

204 Syntax Summary Syntax Conventions In this syntax section, syntactic categories (nonterminals) are indicated by it

Neuron C Reference Guide 205 Neuron-C-declaration : task-declaration io-object-declaration ; functional-block-declaration ; device-prope

206 Syntax Summary declaration-specifier-list : declaration-specifier-list declaration-specifier declaration-speci

Neuron C Reference Guide 207 Storage Classes The ANSI C storage classes are augmented in Neuron C with the additional classes config, eeprom,

208 Syntax Summary enum-const-list : enum-const-list , enum-const enum-const enum-const : variable-identifier

Neuron C Reference Guide 209 cp-info : cp_info ( cp-option-list ) cp-option-list : cp-option-list , cp-option cp-option-list cp-opti

Neuron C Reference Guide 3 offline online reset timer_expires (unqualified) wink All other predefined events can be used in multiple when cla

210 Syntax Summary bind-info-option : auth ( configurable-keyword ) authenticated ( configurable-keyword ) auth

Neuron C Reference Guide 211 function-parameter-declaration : formal-parameter-declaration prototype-parameter-declaration formal-paramete

212 Syntax Summary abstract-decl-specifier : type-specifier cv-type-qualifier Task Declarations Neuron C contains t

Neuron C Reference Guide 213 parm-declaration : declaration-specifier-list parm-declarator-list ; parm-declarator-list : parm-declarat

214 Syntax Summary message-event : message-event-keyword ( expression ) message-event-keyword message-event-keywo

Neuron C Reference Guide 215 modified-io-object-declarator : io-object-declarator [ io-option-list ] io-option-list : io-option-list io-op

216 Syntax Summary select ( io-object-pin-name ) short single_tc slave slave_b __slow sync ( io-object-pin

Neuron C Reference Guide 217 The functional block name can specify either a scalar or a single-dimensioned array (like a network variable dec

218 Syntax Summary property-instantiation : [ property-qualifier ] cpnv-prop-ident [ property-qualifier ] cp-fami

Neuron C Reference Guide 219 incomplete-stmt : label : incomplete-stmt for-head incomplete-stmt if-else-head incomplete-stmt if-head stat

4 Predefined Events The reference value is the value read the last time the change event evaluated to TRUE. For the unqualified io_changes event, t

220 Syntax Summary choice-expr : logical-or-expr ? expression : choice-expr logical-or-expr logical-or-expr : logi

Neuron C Reference Guide 221 add-op : one of + | - multiplicative-expr : multiplicative-expr mul-op cast-expr cast-expr mul-op : one

222 Syntax Summary Primary Expressions, Built-in Variables, and Built-in Functions In addition to the ANSI C definiti

Neuron C Reference Guide 223 eeprom_memcpy fblock_director get_fblock_count | get_nv_count get_tick_count high_byte interrupt_c

224 Syntax Summary #define INT_MAX 127 #define INT_MIN ((int)(-128)) #define UINT_MAX 255 #define LONG_MAX 32767

Neuron C Reference Guide 225 B Reserved Keywords This chapter lists all Neuron C Version 2.2 reserved keywords, including the standard reser

226 Reserved Keywords Reserved Words List The following list of reserved words includes keywords in the Neuron C lang

Neuron C Reference Guide 227 case (c) changeable_type (2) char (c) charge_pump_enable (f) clock (1) clockedge (1) COMM_IGNORE (e) config (1)

228 Reserved Keywords invert (1) IO_0 (1) IO_1 (1) IO_10 (1) IO_11 (2.1) IO_2 (1) IO_3 (1) IO_4 (1) IO_5 (1) IO_6 (1)

Neuron C Reference Guide 229 nonauthenticated (1) nonbind (1) nonconfig (1) nonpriority (1) numbits (1) nv_array_index (v) nv_in_addr (v) nv_

Neuron C Reference Guide 5 } Example 2 IO_7 input pulsecount total_ticks; when (io_changes(total_ticks) by 100) { ... } io_in_ready Eve

230 Reserved Keywords slave (1) slave_b (1) sleep (f) sleep_flags (et,t) __slow spi (2.1) spi_abort (2.1) spi_get_err

Neuron C Reference Guide 231 _bcd2bin _bin2bcd _bit_input _bit_input_ext _bit_output_ext _bit_output_hi _bit_output_lo1 _bit_output_lo2 _bi

232 Reserved Keywords _io_sci_set_buffer_out _io_scispi_abort _io_scispi_input_ready _io_scispi_output_ready _io_set_

Neuron C Reference Guide 233 _nv_array_update_succeeds _nv_poll _nv_poll_all _nv_update_completes _nv_update_fails _nv_update_occurs _nv_upda

Neuron C Reference Guide 235 Index _ __lock keyword, 201 3 32-bit integers. See signed 32-bit integers A A/D converter, 96, 100 a2d.h include

236 Index bypass mode, 114, 118, 124, 155 byte I/O object, 4, 91, 104, 105 byte.h include file. See include files C c

Neuron C Reference Guide 237 declarator syntax, 210 delay fixed, 79 scalable, 130 delay( ) function, 41, 130 definition, syntax and example,

238 Index fl_sqrt( ) function, 47, 62 fl_sub( ) function, 47, 62 fl_to_ascii( ) function, 47, 66 fl_to_ascii_fmt( ) f

Neuron C Reference Guide 239 sci_abort( ), 131 sci_get_error( ), 131 service_pin_msg_send( ), 132 service_pin_state( ), 132 set_bit( ), 133 s

6 Predefined Events when (io_out_ready(io_bus)) { io_out(io_bus, &data); } io_update_occurs Event The io_update_occurs event evaluates to T

240 Index I/O object type names, 91 I/O object types optional definitions, 97 I/O objects, xx clock value of, 103 dec

Neuron C Reference Guide 241 M magcard I/O object, 92, 94 magtrack1 I/O object, 92, 94 make_long( ) function, 44 definition, syntax and examp

242 Index configuration property, 164 connection information, 167 const keyword, 162 controlling propagation of outpu

Neuron C Reference Guide 243 O object_disabled keyword, 172 objects built-in, 198 offchip keyword, 163 off-chip memory, 20 offline event, 86,

244 Index repeating timer, 158 reserved words, 226 reset, 191 determining cause of, 120 reset cause register clearing

Neuron C Reference Guide 245 set_netvar_count pragma, 34 set_node_sd_string pragma, 34 set_std_prog_id pragma, 35 SFPTs, xix SHRT_MAX, 223 SH

246 Index alternate clock assignment, 103 I/O input, 101 timer_expires event, 158 definition, syntax and example, 17

www.echelon.com

Neuron C Reference Guide 7 msg_arrives Event The msg_arrives event evaluates to TRUE once for each a message that arrives. This event can

8 Predefined Events } msg_fails Event The msg_fails event evaluates to TRUE when a message fails to be acknowledged after all retries have been at

Neuron C Reference Guide 9 ... msg_out.tag = tag_out; msg_send(); ... when (msg_succeeds(tag_out)) { ... } nv_update_complet

Neuron C Reference Guide iii Welcome This manual describes the Neuron® C Version 2.2 programming language. It is a companion piece to the Neu

10 Predefined Events Example 1 – Event for a Single Network Variable network output SVNT_abs_humid nvoHumidity; ... nvoHumidity = 32; // This

Neuron C Reference Guide 11 array, the nv_array_index built-in variable indicates the relative index of the element to which the event applie

12 Predefined Events ... when (nv_update_fails(nvoHumidity)) { ... } Example 3 – Event for a Range of Network Variables network output SVNT_a

Neuron C Reference Guide 13 Example 1 – Event for a Single Network Variable network input SNVT_switch nviSwitch; when (nv_update_occurs(nviS

14 Predefined Events If a program checks for the nv_update_succeeds event, it must check for the nv_update_fails event as well. The alternative is

Neuron C Reference Guide 15 nvoHumidity3; ... nvoHumidity2 = 32; ... when (nv_update_succeeds(nvoHumidity1 .. nvoHumidity3)) {

16 Predefined Events online Event The online event evaluates to TRUE only if the device is offline and an Online network management message is rec

Neuron C Reference Guide 17 Syntax reset Example when (reset) { // initialize peripheral devices, and so on } resp_arrives Event The res

18 Predefined Events Example mtimer countdown; ... countdown = 100; ... when (timer_expires(countdown)) { ... } wink Event The wink

Neuron C Reference Guide 19 2 Compiler Directives This chapter provides reference information for compiler directives, also known as pragmas

iv  Introduction to the LONWORKS Platform (078-0391-01A). This manual provides an introduction to the ISO/IEC 14908 (ANSI/CEA-709.1 and EN14908) Con

20 Compiler Directives Compiler Directives ANSI C permits compiler extensions through the #pragma directive. These d

Neuron C Reference Guide 21 #pragma app_buf_in_size size [, modifier] See Allocating Buffers in Chapter 8, Memory Management, of the Neuron C

22 Compiler Directives The create_cp_value_files_uninit option is used to prevent the compiler from generating config

Neuron C Reference Guide 23 In certain situations when linking a program for a Neuron 3150 Chip or a 3150 Smart Transceiver, it might be nece

24 Compiler Directives #pragma debug option This pragma allows selection of various network debugger features. A pro

Neuron C Reference Guide 25 #pragma disable_servpin_pullup Disables the internal pullup resistor on the service pin. This pullup resistor is

26 Compiler Directives This directive has no effect for a Series 5000 chip because Series 5000 chips do not have on-c

Neuron C Reference Guide 27 #pragma idempotent_duplicate_off #pragma idempotent_duplicate_on These pragmas control the idempotent request ret

28 Compiler Directives directive defines the myToolkit.lib file within the “c:\LonWorks\myProjects” directory: #pragm

Neuron C Reference Guide 29 This directive is not supported in model files. #pragma net_buf_in_count count [, modifier] See Allocating Buffer

Neuron C Reference Guide v Typeface or Symbol Used for Example italic type abstract elements identifier [square brackets] optional fields

30 Compiler Directives Development Tool, valid values for num are 0 to 127. In Neuron C Version 2.2 (and later), the

Neuron C Reference Guide 31 Level Optimization Performed Notes 1 No optimization Default for debug targets 2 Minimal optimization CP temp

32 Compiler Directives The #pragma optimization directive replaces the following directives: #pragma codegen cp_famil

Neuron C Reference Guide 33 #pragma relaxed_casting_off #pragma relaxed_casting_on These pragmas control whether the compiler treats a cast t

34 Compiler Directives Note this directive can be used to state compatibility with a guidelines version that is not a

Neuron C Reference Guide 35 #pragma set_std_prog_id hh:hh:hh:hh:hh:hh:hh:hh Provides a mechanism for setting the device’s 8-byte program ID.

36 Compiler Directives #pragma specify_io_clock string Specify this directive to inform the compiler of the value of

Neuron C Reference Guide 37 Neuron 3120E1 Chip, Neuron 3120E2 Chip, and 3120 Smart Transceiver, firmware version 6 (or later) supports either

38 Compiler Directives ... #else #ifdef YYY ... #else #error “You must define either XXX or YYY”

Neuron C Reference Guide 39 3 Functions This chapter provides reference information on the Neuron C built-in and library functions. Built-i

40 Functions Introduction This chapter lists Neuron C functions, providing syntax information, descriptions, and exam

Neuron C Reference Guide 41 variables and floating-point arithmetic, and a discussion of the use of extended precision variables and extended

42 Functions Function Description go_offline( ) Cease execution of the application program interrupt_control( ) En

Neuron C Reference Guide 43 Function Description addr_table_index( ) Determine address table index of message tag application_restart( ) B

44 Functions Function Description bin2bcd( ) Convert binary data to binary coded decimal high_byte( ) Extract the

Neuron C Reference Guide 45 Function Description s32_div( ) Divide two signed 32-bit numbers s32_div2( ) Divide a 32-bit signed number by

46 Functions Function Description s32_rem( ) Return the remainder of a division of two signed 32-bit numbers s32_si

Neuron C Reference Guide 47 Function Description fl_from_ulong( ) Convert an unsigned long number to a floating-point number fl_ge( ) Retu

48 Functions Function Description fl_to_ascii_fmt( ) Convert a floating-point number to a formatted ASCII string fl

Neuron C Reference Guide 49 Table 11. Utility Functions Function Description ansi_memcpy( ) Copy a block of memory with ANSI return value a

Neuron C Reference Guide vii Table of Contents Welcome...

50 Functions Function Description memset( ) Set a block of memory to a specified value:  length greater than or e

Neuron C Reference Guide 51 Function Description io_in( ) Input data from I/O object:  Dualslope input  Edgelog input  Infrared input

52 Functions Function Description io_set_clock( ) Set timer/counter clock rate io_set_direction( ) Change directio

Neuron C Reference Guide 53 s32_type some_number = {0, 0, 0, 4}; // initialized to 4 on reset s32_type another_number = {-1, -1, -1, -16};

54 Functions Table 13. Binary Arithmetic Operators Short Name Function add void s32_add(const s32_type *arg1, const

Neuron C Reference Guide 55 Short Name Function neg void s32_neg(const s32_type *arg1, s32_type *arg2); Returns the negative of a signed 32-

56 Functions Miscellaneous Signed 32-bit Functions Table 16 lists miscellaneous signed 32-bit functions. Table 16. Si

Neuron C Reference Guide 57 Short Name Function from ulong void s32_from_ulong(unsigned long arg1, s32_type *arg2);Converts a Neuron C unsign

58 Functions Table 20. Signed 32-Bit Function Performance Function Maximum Average Add/subtract 0.10 0.08 Multiply

Neuron C Reference Guide 59 float_type X, A, B, C; fl_mul(&B, &C, &X); fl_add(&X, &A, &X); The floating-point format

viii nv_update_succeeds Event ... 13 Syntax ...

60 Functions A number of #define literals are defined for use by the application to initialize floating-point structu

Neuron C Reference Guide 61 Example: float_type local_angle; // internal variable network output SNVT_angle_f nvoAngle; // network variable

62 Functions Table 21. Binary Arithmetic Operators Short Name Function add void fl_add(const float_type *arg1, co

Neuron C Reference Guide 63 Short Name Function trunc void fl_trunc(const float_type *arg1, float_type *arg2);Returns the whole number part

64 Functions Short Name Function gt boolean fl_gt(const float_type *arg1, const float_type *arg2); Returns TRUE i

Neuron C Reference Guide 65 Table 25. Floating-Point Conversion Functions Short Name Function to slong signed long fl_to_slong(const float_ty

66 Functions Table 26. Conversions of Floating-Point Numbers to ASCII Strings Short Name Function to ascii void fl_

Neuron C Reference Guide 67 Conversion of ASCII String to Floating-Point Table 27 lists the conversion functions for an ASCII srtring to a fl

68 Functions Function Maximum Average Multiply 1.61 1.33 Divide 2.43 2.08 Square Root 10.31 8.89 Multiply/Divide

Neuron C Reference Guide 69 Using the NXT Neuron C Extended Arithmetic Translator You can use the NXT Neuron C Extended Arithmetic Translator

Neuron C Reference Guide ix Conversion of Floating-Point to ASCII String ... 65 Conversion of ASCII String to Floa

70 Functions Syntax type abs (a); Example int i; long l; void f(void) { i = abs(-3); l = abs(-300); } access_add

Neuron C Reference Guide 71 Syntax #include <access.h> const alias_struct *access_alias (int index); Example #include <access.h>

72 Functions Example #include <access.h> network output SNVT_amp nvoAmpere; nv_struct nv_copy; void f(void) {

Neuron C Reference Guide 73 Example #include <mem.h> unsigned buf[40]; unsigned *p; void f(void) { p = ansi_memcpy(buf, "Hello

74 Functions Syntax #include <control.h> void application_restart (void); Example #define MAX_ERRS 50 int error

Neuron C Reference Guide 75 Syntax void bin2bcd (unsigned long value, struct bcd *p); For a definition of struct bcd, see bcd2bin, above. Exa

76 Functions Syntax #include <byte.h> void clr_bit (void *array, unsigned bitnum); Example #include <byte.h&

Neuron C Reference Guide 77 121516 xxx This function is useful in conjunction with the support for the Touch I/O model, but can also be u

78 Functions len Specifies the length of the data buffer, 1 to 255 bytes. A value of 0 represents 256 bytes. Exampl

Neuron C Reference Guide 79 Series 3100 Input Clock Series 5000 System Clock Delay (in microseconds) 625 kHz — 9.6*((max(1,floor(count/16)