Library Description

This library allows user to perform an ESP3 (EnOcean Serial Protocol 3) communication. User can send packet data, which can consist of the commands, telegrams, messages... The library also can be used to check the response from the modul. When the response is ready, the library sets a flag. For more details check documentation.

Key functions:

• T_ENOCEAN4_RETVAL enocean4_procces( void )- This function performs a response proccesing and calls handler function if response is valid.
• T_ENOCEAN4_RETVAL enocean4_responseReady( void )- This function checks the response ready flag and if flag is set, clears a flag.
• T_ENOCEAN4_RETVAL enocean4_sendPacket( T_enocean4_packet *packet )- This function allows user to send a valid packet data to the module by using UART interface.

Examples description

The application is composed of three sections :

• System Initialization - Initializes peripherals and pins.
• Application Initialization - Initializes UART interface and interrupt, and prepares module for telegram sending and receiving. Also determines the working mode of the module, to be transmitter or receiver.
• Application Task - (code snippet) Transmitter case: Sends message 1 and 2 to another module selected by Destination ID in the message structure. After each sent message waits to get answer (response) from another module. Receiver case: Waits to get message from another module and after that sends the determined answer on the received message. The all responses, messages and answers will be sent to the uart terminal.

void applicationTask()
{
    if (device_mode == RECEIVER)
    {
        mikrobus_logWrite( "Telegram receiving...", _LOG_LINE );
        checkResponse();
        mikrobus_logWrite( "***********************************", _LOG_LINE );
        Delay_ms( 5000 );

        mikrobus_logWrite( "Telegram sending...", _LOG_LINE );
        sendTelegram( &_answer1[0], _ENOCEAN4_RORG_ADT );
        checkResponse();
        mikrobus_logWrite( "***********************************", _LOG_LINE );

        mikrobus_logWrite( "Telegram receiving...", _LOG_LINE );
        checkResponse();
        mikrobus_logWrite( "***********************************", _LOG_LINE );
        Delay_ms( 5000 );

        mikrobus_logWrite( "Telegram sending...", _LOG_LINE );
        sendTelegram( &_answer2[0], _ENOCEAN4_RORG_ADT );
        checkResponse();
        mikrobus_logWrite( "***********************************", _LOG_LINE );
    }
    else if (device_mode == TRANSMITTER)
    {
        mikrobus_logWrite( "Telegram sending...", _LOG_LINE );
        sendTelegram( &_message1[0], _ENOCEAN4_RORG_ADT );
        checkResponse();
        mikrobus_logWrite( "***********************************", _LOG_LINE );

        mikrobus_logWrite( "Telegram receiving...", _LOG_LINE );
        checkResponse();
        mikrobus_logWrite( "***********************************", _LOG_LINE );
        Delay_ms( 5000 );

        mikrobus_logWrite( "Telegram sending...", _LOG_LINE );
        sendTelegram( &_message2[0], _ENOCEAN4_RORG_ADT );
        checkResponse();
        mikrobus_logWrite( "***********************************", _LOG_LINE );

        mikrobus_logWrite( "Telegram receiving...", _LOG_LINE );
        checkResponse();
        mikrobus_logWrite( "***********************************", _LOG_LINE );
        Delay_ms( 5000 );
    }
}

Additional Functions :

• respMessage - Sends message about the response state.
• packetType - Sends message about the packet type.
• makeResponse - Allows user to get a response packet from the driver.
• logResponse - Allows results to be sent to the uart terminal.
• sendTelegram - Allows user to send a telegram to the determined destination.
• checkResponse - Waits until response was ready.
• interrupt - To catch response from the module.

Other mikroE Libraries used in the example:

• Conversions
• UART

Additional notes and informations

Depending on the development board you are using, you may need USB UART click, USB UART 2 click or RS232 click to connect to your PC, for development systems with no UART to USB interface available on the board. The terminal available in all MikroElektronika compilers, or any other terminal application of your choice, can be used to read the message.