Function returns the lowest byte of number. Function does not interpret bit patterns of number – it merely returns 8 bits as found in register.

This is an “inline” routine; code is generated in the place of the call, so the call doesn’t count against the nested call limit.

• number: input value

Lowest 8 bits (byte) of number, bits 7..0.

Arguments must be variable of scalar type (i.e. Arithmetic Types and Pointers).

d = 0x12345678 	
tmp = Lo(d)  ' Equals 0x78

Lo(d) = 0xAA ' d equals 0x123456AA

None.

Function returns next to the lowest byte of number. Function does not interpret bit patterns of number – it merely returns 8 bits as found in register.

This is an “inline” routine; code is generated in the place of the call, so the call doesn’t count against the nested call limit.

• number: input value

Returns next to the lowest byte of number, bits 8..15.

Arguments must be variable of scalar type (i.e. Arithmetic Types and Pointers).

d = 0x12345678 	
tmp = Hi(d)  ' Equals 0x56

Hi(d) = 0xAA ' d equals 0x1234AA78

None.

Function returns next to the highest byte of number. Function does not interpret bit patterns of number – it merely returns 8 bits as found in register.

This is an “inline” routine; code is generated in the place of the call, so the call doesn’t count against the nested call limit.

• number: input value

Returns next to the highest byte of number, bits 16..23.

Arguments must be variable of scalar type (i.e. Arithmetic Types and Pointers).

d = 0x12345678
tmp = Higher(d)  ' Equals 0x34

Higher(d) = 0xAA ' d equals 0x12AA5678

None.

Function returns the highest byte of number. Function does not interpret bit patterns of number – it merely returns 8 bits as found in register.

This is an “inline” routine; code is generated in the place of the call, so the call doesn’t count against the nested call limit.

• number: input value

Returns the highest byte of number, bits 24..31.

Arguments must be variable of scalar type (i.e. Arithmetic Types and Pointers).

d = 0x12345678 	
tmp = Highest(d)  ' Equals 0x12

Highest(d) = 0xAA ' d equals 0xAA345678

None.

The function returns low word of val. The function does not interpret bit patterns of val – it merely returns 16 bits as found in register.

Parameters :

• val: input value

Low word of val, bits 15..0.

Nothing.

d = 0x12345678 	
tmp = LoWord(d)  ' Equals 0x5678

LoWord(d) = 0xAAAA ' d equals 0x1234AAAA

None.

The function returns high word of val. The function does not interpret bit patterns of val – it merely returns 16 bits as found in register.

Parameters :

• val: input value

High word of val, bits 31..16.

Nothing.

d = 0x12345678 	
tmp = HiWord(d)  ' Equals 0x1234

HiWord(d) = 0xAAAA ' d equals 0xAAAA5678

None.

Increases parameter par by 1.

• par: value which will be incremented by 1

Nothing.

Nothing.

p = 4
Inc(p)  ' p is now 5

None.

Decreases parameter par by 1.

• par: value which will be decremented by 1

Nothing.

Nothing.

p = 4
Dec(p)  ' p is now 3

None.

Function returns a character associated with the specified character code_. Numbers from 0 to 31 are the standard non-printable ASCII codes.

This is an “inline” routine; the code is generated in the place of the call.

• code_: input character

Returns a character associated with the specified character code_.

Nothing.

c = Chr(10)  ' returns the linefeed character

None.

Function returns ASCII code of the character.

This is an “inline” routine; the code is generated in the place of the call.

• character: input character

ASCII code of the character.

Nothing.

c = Ord("A")  ' returns 65

None.

Function sets the bit rbit of register_. Parameter rbit needs to be a variable or literal with value 0..15. For more information on register identifiers see Predefined Globals and Constants .

This is an “inline” routine; the code is generated in the place of the call.

• register_: desired register
• rbit: desired bit

Nothing.

Nothing.

SetBit(PORTB, 2)  ' Set RB2

None.

Function clears the bit rbit of register. Parameter rbit needs to be a variable or literal with value 0..15. See Predefined globals and constants for more information on register identifiers.

This is an “inline” routine; code is generated in the place of the call, so the call doesn’t count against the nested call limit.

• register_: desired register
• rbit: desired bit

Nothing.

Nothing.

ClearBit(PORTC, 7)  ' Clear RC7

None.

Function tests if the bit rbit of register is set. If set, function returns 1, otherwise returns 0. Parameter rbit needs to be a variable or literal with value 0..15. See Predefined globals and constants for more information on register identifiers.

This is an “inline” routine; code is generated in the place of the call, so the call doesn’t count against the nested call limit.

• register_: desired register
• rbit: desired bit

If the bit is set, returns 1, otherwise returns 0.

Nothing.

flag = TestBit(PORTE, 2)  ' 1 if RE2 is set, otherwise 0

None.

Creates a software delay in duration of Time_In_us microseconds.

This is an “inline” routine; the code is generated in the place of the call, so the call doesn’t count against the nested call limit.

• Time_In_us: delay time in microseconds. Valid values: constant values, range of applicable constants depends on the oscillator frequency

Nothing.

Nothing.

Delay_us(1000)  ' One millisecond pause

None.

Creates a software delay in duration of Time_In_ms milliseconds.

This is an “inline” routine; the code is generated in the place of the call, so the call doesn’t count against the nested call limit.

• Time_In_ms: delay time in milliseconds. Valid values: constant values, range of applicable constants depends on the oscillator frequency

Nothing.

Nothing.

Delay_ms(1000)  ' One second pause

For generating delays with variable as input parameter use the Vdelay_ms routine.

Creates a software delay in duration of Time_ms milliseconds. Generated delay is not as precise as the delay created by Delay_ms.

• Time_ms: delay time in milliseconds

Nothing.

Nothing.

pause = 1000
' ...
Vdelay_ms(pause)  ' ~ one second pause

None.

Creates a software delay in duration of time_in_ms milliseconds (a variable), for a given oscillator frequency. Generated delay is not as precise as the delay created by Delay_ms.

Note that Vdelay_ms is library function rather than a built-in routine; it is presented in this topic for the sake of convenience.

• time_ms: delay time in milliseconds
• Current_Fosc_kHz: frequency in kHz

Nothing.

Nothing.

pause = 1000
fosc = 10000

VDelay_advanced_ms(pause, fosc)  ' Generates approximately one second pause, for a oscillator frequency of 10 MHz

None.

Creates a delay based on MCU clock. Delay lasts for x*16384 + y MCU clock cycles.

• x: NumberOfCycles divided by 16384
• y: remainder of the NumberOfCycles/16384 division

Nothing.

Nothing.

Delay_Cyc(1, 10)  ' 1x16384 + 10 = 16394 cycles pause 

Delay_Cyc is a library function rather than a built-in routine; it is presented in this topic for the sake of convenience.

Creates a delay based on MCU clock. Delay lasts for CycNo MCU clock cycles.

• CycNo: number of MCU cycles

Nothing.

Nothing.

Delay_Cyc_Long(16384)  ' 16384 cycles pause 

Delay_Cyc_Long is a library function rather than a built-in routine; it is presented in this topic for the sake of convenience.

Returns device clock in kHz, rounded to the nearest integer.

This is an “inline” routine; the code is generated in the place of the call.

None.

Device clock in kHz, rounded to the nearest integer.

Nothing.

clk = Clock_kHz()

None.

Returns device clock in MHz, rounded to the nearest integer.

This is an “inline” routine; the code is generated in the place of the call.

None.

Device clock in MHz, rounded to the nearest integer.

Nothing.

clk = Clock_MHz()

None.

Function returns device clock in kHz, rounded to the nearest integer.

None.

Device clock in kHz.

Nothing.

clk = Get_Fosc_kHz()

Get_Fosc_kHz is a library function rather than a built-in routine; it is presented in this topic for the sake of convenience.

Function returns device's clock per cycle, rounded to the nearest integer.

Note that Get_Fosc_Per_Cyc is library function rather than a built-in routine; it is presented in this topic for the sake of convenience.

None.

Device's clock per cycle, rounded to the nearest integer.

Nothing.

dim clk_per_cyc as word
...
clk_per_cyc = Get_Fosc_Per_Cyc()

None.

This procedure is equal to assembler instruction reset.

None.

Nothing.

Nothing.

Reset() ' Resets the MCU

None.

This procedure is equal to assembler instruction clrwdt.

None.

Nothing.

Nothing.

ClrWdt() ' Clears WDT

None.

Use the DisableContextSaving() to instruct the compiler not to automatically perform context-switching. This means that no register will be saved/restored by the compiler on entrance/exit from interrupt service routine. This enables the user to manually write code for saving registers upon entrance and to restore them before exit from interrupt.

None.

Nothing.

This routine must be called from main.

DisableContextSaving() ' instruct the compiler not to automatically perform context-switching

None.

If the linker encounters an indirect function call (by a pointer to function), it assumes that any routine whose address was taken anywhere in the program can be called at that point if it's prototype matches the pointer declaration.

Use the SetFuncCall directive within routine body to instruct the linker which routines can be called indirectly from that routine :
SetFunCCall (called_func[, ,...])

Routines specified in the SetFunCCall argument list will be linked if the routine containing SetFunCCall directive is called in the code no matter whether any of them was explicitly called or not.

Thus, placing SetFuncCall directive in main will make compiler link specified routines always.

• FuncName: function name

Nothing.

Nothing.

sub procedure first(p, q as byte)
...
  SetFuncCall(second) ' let linker know that we will call the routine 'second'
...
end sub

The SetFuncCall directive can help the linker to optimize function frame allocation in the compiled stack.

Use the SetOrg() routine to specify the starting address of a routine in ROM.

• RoutineName: routine name
• address: starting address

Nothing.

This routine must be called from main.

SetOrg(UART1_Write, 0x1234)

None.

Use the DoGetDateTime() to get date and time of compilation as string in your code.

None.

String with date and time when this routine is compiled.

Nothing.

str = DoGetDateTime()

None.

Use the DoGetVersion() to get the current version of compiler.

None.

String with current compiler version.

Nothing.

str = DoGetVersion() ' for example, str will take the value of '8.2.1.6'

None.

This function adds a given number to a pointer to a constant allocated in the far program memory space.

• ptr: pointer to a constant allocated in the far program memory space.
• increment: number to increment pointer by.

Nothing.

Nothing.

dim cpointer as ^far const byte     ' pointer to a const array in far program memory space
const const_array as byte[10] = (0,1,2,3,4,5,6,7,8,9)    ' const array allocated in far program memory space
...
cpointer = @const_array[5]
__AddToFarPointer(cpointer, 1)  ' increment pointer by 1; cpointer now points to const_array[6]

None.

This function subtracts pointer to a constant allocated in the far program memory space by a given number.

• ptr: pointer to a constant allocated in the far program memory space.
• decrement: number to decrement pointer by.

Nothing.

Nothing.

dim cpointer as ^far const byte     ' pointer to a const array in far program memory space
const const_array as byte[10] = (0,1,2,3,4,5,6,7,8,9)    ' const array allocated in far program memory space
...
cpointer = @const_array[5]
__AddToFarPointer(cpointer, 1)  ' decrement pointer by 1; cpointer now points to const_array[4]

None.

This function converts a given Flash memory address to a pointer to a constant allocated in the far program memory space.

• address: address in Flash memory to be converted.

Pointer to a constant allocated in the far program memory space.

Nothing.

None.

This function converts a pointer to a constant (allocated in the far program memory space) to the appropriate Flash memory address.

• ptr: pointer to a constant allocated in the far program memory space.

Appropriate Flash memory address.

Nothing.

None.

Allocates a block of memory from the memory Heap, taking care of the alignment. It is recommended to use this routine instead of GetMem.

• Ptr: variable of any pointer type, pointing to an object which is to be allocated.

Returns a pointer to the memory block allocated by the function; Otherwise 0 (no free blocks of memory are large enough).

Nothing.

None.

Disposes a block of memory from the memory Heap, referenced by Ptr and returns its memory to the Heap.

• Ptr: variable of any pointer type previously assigned by the New procedure.

Nothing.

After calling this routine, the value of Ptr is nil (0) (not assigned pointer).