GCBASIC documentation
HEFM ( PFM )

Syntax:

    'as a subroutine
    HEFRead ( location, data )

    'as a function
    data = HEFRead ( location )

Command Availability:

Available on all PIC micro-controllers with HEFM memory

Explanation:

HEFRead is used to read information, byte values, from HEFM, so that it can be accessed for use in a user program.

location rerepresents the location or relative address to read. The location will range from location 0 to HEF_BYTES - 1, or for all practical purposes 0-127 since all PIC Microcontrollers with HEF support 128 bytes of HEF Memory. HEF_BYTES is a GCBASIC constant that represents the number of bytes of HEF Memory.   

data is the data that is to be read from the HEFM data storage area.    This can be a byte value or a byte variable.

This method reads data from HEFM given the specific relative location.    This method is similar to the EPRead method for EEPROM.

Example 1:

    '... code preamble to select part
    '... code to setup PPS
     '... code to setup serial

    'The following example reads the HEFM data value into the byte variable “byte_value” using a subroutine.

    Dim data_byte as byte

    ;Write a byte of data to HEFM Location 34
    HEFWrite( 34, 144)

    ;Read the byte back from HEFM location 34
    HEFread( 34, byte_value )          ' <<< the HEFRead instruction (subroutine form)

    ;Display the data on a terminal
    HserPrint "byte_value = "
    Hserprint byte_value

Key line: HEFread( 34, byte_value ) — reads the byte back from HEFM location 34 using the subroutine form, storing the result directly into byte_value.

Example 2:

    '... code preamble to select part '... code preamble to select part
    '... code to setup PPS
     '... code to setup serial

    'The following example reads the HEFM data value into the byte variable “byte_value” using a function.

    Dim data_byte as byte

    ;Write a byte of data to HEF Location 34
    HEFWrite( 34, 144)

    ;Read the byte back from HEF location 34
    byte_value = HEFread( 34 )          ' <<< the HEFRead instruction (function form)

    ;Display the data on a terminal
    HserPrint "byte_value = "
    Hserprint byte_value

Key line: byte_value = HEFread( 34 ) — reads the byte back from HEFM location 34 using the function form, assigning the result to byte_value.

See Also: