dolphin4-api/EO3100I_API_Documentation/reman_device_page.html

/************************************************************************-

EVA Board:

    EVA320-3


Input PIN:

    ADIO_4       Reseting the REMAN code to default code 0x00000001


Output PIN:

    ADIO_7       Reaction on REMAN action command


Description:

    This example demonstrates how to integrate Remote Management in a device application.


    The following Remote Management Controll Commands (RMCC) are implemented:

    - Lock, Unlock, SetCode, QueryID, Action, QueryStatus, Ping, QueryFunction


    The following Remote Procedure Calls (RPC) are implemented:

    - RemoteRead, RemoteWrite


    Pressing the ADIO_4 button resets the REMAN code manualy


-************************************************************************/

#include "EO3100I_API.h"

#include "EO3100I_CFG.h"

#include <string.h>


// Application version string

code uint8 VERSION_APP[] = {0xE0,'V','E','R','S','I','O','N',1,0,3,1,'A','R','E','M','A','N','D','E','V','I','C','E',0x00,0xE0};


// RPC list definition

code uint16 reman_rpc[] =   {

            RM_FN_REMOTE_LEARN, RM_DEFAULTMANID,

            RM_FN_REMOTE_WRITE, RM_DEFAULTMANID,

            RM_FN_REMOTE_READ,  RM_DEFAULTMANID,

};


#define REMAN_DEFAULT_CODE (0x01)


void main()

{


    TEL_PARAM_TYPE      pTel;

    TEL_RADIO_TYPE      rTel;

    uint16              u16FnNumber;

    uint16              u16DataSize;

    uint32              u32Code;


    // REMOTE_READ variables

    uint16      u16NumBytes  = 0;

    uint16      u16FlashAddr = 0;

    uint8       u8Val;


    mainInit();

    radio_enableRx(1);

    // Initialize RPC list

    reman_setRPC(reman_rpc, sizeof(reman_rpc)>>2);


    while (1)

    {

        CLR_WDT();


        //Make sure to have a backdoor to reset the code through pressing a key on the module, otherwise if the REMAN code is lost, the module stays locked forewer

        //Reman cannot be unlocked, if code is not set. So at least once you have to press ADIO_4 to initialize it with the default code. Usually you shall do it

        //outside of the loop in your cold start initialisation.

        io_getDigital(ADIO_4, &u8Val);

        if (u8Val == 0)

        {

            u32Code = REMAN_DEFAULT_CODE;

            mem_writeFlash((uint8*)(&u32Code), RM_CODE_ADDR, sizeof(u32Code));

            reman_init(reman_param, SET_ALL_PARAM);

            io_togDigital(ADIO_7);

            time_wait(300);

            io_togDigital(ADIO_7);

            time_wait(2000);

        }


        if (reman_processSend()==OK)

        {

            // Telegram was actually send through radio. We could do some debug LED blinking here

        }


        // Receive radio telegram

        if (radio_getTelegram(&rTel, &pTel) != OK)

            continue;


        // Remote management module process received telegram

        if (reman_receiveTelegram(&rTel, &pTel, &u16FnNumber, &u16DataSize) == OK)

        {

            switch(u16FnNumber)

            {

                case RM_FN_SET_CODE:

                    // The aplication has to save the code to flash at RM_ADDR_CODE address. You can do it here or perhaps later.

                    reman_getCode(&u32Code);

                    mem_writeFlash((uint16)(&u32Code), RM_CODE_ADDR, sizeof(u32Code));

                    break;


                case RM_FN_ACTION_COMMAND:

                    if (misc_isLocalId(&pTel.p_rx.u32DestinationId))

                    {

                        io_togDigital(ADIO_7);

                        time_wait(500);

                        io_togDigital(ADIO_7);

                    }

                    break;


                case RM_FN_REMOTE_READ:

                    // We don't reply to broadcast, so we check the destination ID

                    if (misc_isLocalId(&pTel.p_rx.u32DestinationId))

                    {

                        u16FlashAddr = u8gRmDataBuffer[0]<<8 | u8gRmDataBuffer[1];

                        u16NumBytes  = u8gRmDataBuffer[2]<<8 | u8gRmDataBuffer[3];


                        if (u16FlashAddr<0x7D00 || u16FlashAddr>0x7EFF)

                        {

                            reman_setError(RM_RETURN_CODE_ADDRESS_OUT_OF_RANGE);

                            break;

                        }


                        if (reman_sendMessage((uint8 code *)u16FlashAddr, u16NumBytes, RM_FN_REMOTE_READ_ANS, FALSE)!=OK)

                        {

                            reman_setError(RM_RETURN_CODE_DATA_SIZE_EXCEEDED);

                        }

                    }

                    break;


                case RM_FN_REMOTE_WRITE:

                    // We react on both broadcast and addressed telegrams so no ID checking is needed

                    u16FlashAddr = u8gRmDataBuffer[0]<<8 | u8gRmDataBuffer[1];

                    u16NumBytes  = u8gRmDataBuffer[2]<<8 | u8gRmDataBuffer[3];


                    if (u16FlashAddr<0x7D00 || u16FlashAddr>0x7EFF)

                    {

                        reman_setError(RM_RETURN_CODE_ADDRESS_OUT_OF_RANGE);

                        break;

                    }


                    if (u16NumBytes>256)

                    {

                        reman_setError(RM_RETURN_CODE_DATA_SIZE_EXCEEDED);

                        break;

                    }


                    if(mem_writeFlash(&u8gRmDataBuffer[4], u16FlashAddr, u16NumBytes)==OK)

                        reman_setError(RM_RETURN_CODE_OK);

                    else

                        reman_setError(RM_RETURN_CODE_RPC_FAILED);


                    break;


                case RM_FN_REMOTE_LEARN:

                    // Do something useful

                    break;


            } // switch

        } //reman_receiveTelegram

    } // application loop

}