Предоставлен сервер SDO по умолчанию. Термин "сервер" в данном контексте означает, что код сервера выполняет какие-то запросы клиента SDO (обычно это мастер сети CANopen). Путь коммуникаций SDO прямо привязан к OD; сообщения SDO содержат информацию, которая связывает SDO с определенным объектом. Данные каждого сообщения декодируются, проверяются на достоверность и (если они достоверны) выполняются как событие.

В сущности здесь работают 2 основные операции: чтение (read) и запись (write). Каждая полная передача SDO (которая может состоять из нескольких сообщений) будет либо читать, либо записывать один определенный объект OD. Объект SDO по умолчанию находится в исходных файлах CO_SDO1.c и CO_SDO1.h.

Путь коммуникаций PDO (Process Data Object) непосредственно отображен на объект (или объекты) приложения. Таким образом, путь подразумевается устройством, и в коммуникации не содержится никакой информации о пути. В сущности данные PDO внутренне отображены на один или большее количество объектов (по-русски можно сказать так: в программе есть некоторые переменные, и данные этих переменных присуствуют в PDO). Данные отображаются либо статически (отображение определяется один раз во время компиляции проекта), либо динамически (может быть установлена во время выполнения приложения с помощью обработки команд, поступающих серверу SDO). Одно сообщение может содержать в себе данные более чем одного объекта приложения.

Код firmware, предоставляемый с этим апноутом, поддерживает 4 объекта PDO по умолчанию. Все службы PDO предоставлены в исходных файлах CO_PDO.c и CO_PDO.h. Дополнительные файлы CO_PDOn.c и CO_PDOn.h (здесь n может иметь значение от 1 до 4) используются для реализации отдельных объектов PDO. Они предоставлены в форме шаблона, и должны быть разработаны для удовлетворения требований приложения.

Предоставлено подчиненное устройство, принимающее команды управления сетью (Network Management, сокращенно NMT), как этого требует стандарт CANopen. Объект NMT принимает команды для изменения состояния устройства, или сброса приложения устройства и/или его коммуникаций. На рис. 2 показана машина состояний CANopen, а также команды, которые вызывают срабатывание переходов между состояниями.

Рис. 2. Алгоритмическая машина состояний устройства CANopen.

Примечание: не снабженные метками переходы (которые показаны более черными линиями) являются автоматическими и не требуют внешнего события.

Обработка NMT предоставлена в исходных файлах CO_NMT.c и CO_NMT.h.

Спецификациями CANopen требуется, чтобы была одна конечная точка протокола Node Guard или Heartbeat (это 2 разных протокола, и требуется наличие поддержки одного из них). Имеется код обоих этих протоколов; однако в любой момент времени разрешен только один из этих методов поддержки целостности узлов сети (это также определено спецификациями).

Функционал конечной точки Node Guard и Heartbeat предоставлен в исходных файлах CO_NMTE.c и CO_NMTE.h.

Предоставлен один потребитель сообщений синхронизации (synchronization consumer, SYNC). Сообщение SYNC просто предоставляет приложению событие, по которому приложение генерирует любые синхронные сообщения PDO.

Исходные файлы CO_SYNC.c и CO_SYNC.h содержат в себе объект SYNC.

В описанном стеке используется свой формат идентификаторов CAN, привязанный к архитектуре CAN микроконтроллеров PIC, это так называемый формат MCHP (или формат Microchip). Соответствие между идентификатором в формате CANopen и идентификатором в формате MCHP показано ниже.

Байт:          B3        B2        B1        B0
               --------  --------  --------  --------
Формат CANopen 28 .. 24  23 .. 16  15 ..  8  7  ..  0
               nmtxxxxx  xxxxxxxx  xxxxxxxx  xxxxxxxx
MCHP format    7  ..  0  15 ..  8  20 .. 16  28 .. 21
               xxxxxxxx  xxxxxxxx  xxxntmxx  xxxxxxxx

Формат CANopen                     10 ..  8  7  ..  0
               nmt-----  --------  -----xxx  xxxxxxxx
MCHP format                        3  ..  0  10 ..  3
               --------  --------  xxxntm--  xxxxxxxx

n = бит опций 1
m = бит опций 2
t = тип идентификатора (standard = 0, extended = 1)

void mCO_ProcessAllEvents(void)

Это основная подпрограмма, из которой обрабатываются все события. Отсюда обрабатываются все события передачи и приема в Менеджере Коммуникаций. Эта функция должна вызываться так часто, как это только возможно, чтобы можно было обработать любые события коммуникации. Насколько часто это нужно - сильно зависит от драйвера и необходимости ответить на все события драйвера до наступления переполнения.

Пример:

void main(void)
{
   // Выполнение любой специфичной для приложения инициализации:
   TimerInit();   // инициализация таймера
   mSYNC_SetCOBID(0x12);      // Установка SYNC COB-ID (в формате MCHP)
   mCO_SetNodeID(0x01);       // Установка идентификатора узла
   mCO_SetBaud(0x00);         // Установка скорости
   mNMTE_SetHeartBeat(0x00);  // Установка начального heartbeat
   mNMTE_SetGuardTime(0x00);  // Установка начального guard time
   mNMTE_SetLifeFactor(0x00); // Установка начального life time
   mCO_InitAll();             // Инициализация CANopen для запуска
   
   while(1)
   {
      // Обработка событий CANopen:
      mCO_ProcessAllEvents();
      // Обработка специфичных для приложения функций
      ...
      if (TimerIsOverflowEvent())
      {
         // Событие таймера: сюда попадаем каждую 1 мс.
         // Обработка связанных с таймером событий:
         mCO_ProcessAllTimeEvents();
         // Выполнение других функций, привязанных к отсчету реального времени:
         ...
      }
   }
}

void mCO_ProcessAllTimeEvents(void)

Это основная подпрограмма, из которой обрабатываются все события, связанные с реальным временем низкого разрешения. Эта функция должна быть вызвана с интервалом 1 мс. События высокого разрешения (обычно в области микросекунд) должны обрабатываться в приложении. Внутренне эта функция гарантирует, что все объекты стека, которые требуют управления по времени, получили свое событие тика.

Пример см. в предыдущей врезке, где приведено описание подпрограммы mCO_ProcessAllEvents.

void mCO_InitAll(void)

Эта функция должна вызываться после установки всех начальных параметров объектов. Она выдает сброс драйверу CAN, и запускает открытие требуемых коммуникаций. После этого вызова узел появится в сети, и будет отправлено сообщение boot-up.

Функция mCO_InitAll в настоящее время является макросом-оберткой над функцией _CO_COMMResetEventManager. Она должна быть вызвана перед входом в главный цикл main приложения. Пример:

void main(void)
{
   // В этом месте выполняются инициализации, специфичные

   // (настройка выводов GPIO, аппаратуры и т. п.):

   ...
   TimerInit();               // Инициализация таймера
   mSYNC_SetCOBID(0x1000);    // Установка SYNC COB-ID (в формате MCHP)
   mCO_SetNodeID(0x02);       // Установка Node ID
   mCO_SetBaud(0x00);         // Установка скорости CAN
   mNMTE_SetHeartBeat(20000); // Установка начального heartbeat
   mNMTE_SetGuardTime(0000);  // Установка начального guard time
   mNMTE_SetLifeFactor(0x00); // Установка начального life time
   DemoInit();                // Инициализация демонстрационного объекта AN945
   mCO_InitAll();             // Инициализация стека CANopen для запуска, будет
                              // отправлено сообщение boot-up
   while(1)
   {
      // Обработка событий CANopen:
      mCO_ProcessAllEvents();
      // Обработка событий, специфичных для приложения:
      DemoProcessEvents();
      // События таймера происходят с периодом 1 мс:
      if (TimerIsOverflowEvent())
      {
         // Обработка событий, связанных с таймером
         mCO_ProcessAllTimeEvents();
      }
   }
}

void mCO_SetNodeID(unsigned char node_id)

Вызовите эту функцию для установки идентификатора узла node_id. Значение node_id должно быть типа unsigned char, где самый старший бит сброшен (его использование зарезервировано). Дополнительно спецификация CANopen резервирует значение 00h для NodeID. Таким образом, допустимое значение для идентификатора узла node_id находится в диапазоне 01h .. 7Fh включительно. Эта функция должна быть вызвана перед mCO_InitAll().

Параметр:

unsigned char node_id: идентификатор этого узла, допустим диапазон от 01h до 7Fh.

Пример см. во врезке, где приведено описание подпрограммы mCO_ProcessAllEvents.

unsigned char node_id mCO_GetNodeID(void)

Вызовите эту функцию, чтобы получить значение текущего ID, используемого стеком. Значение будет возвращено как unsigned char, допустимый диапазон 01h..7Fh.

void mCO_SetBaud(unsigned char bitrate)

Вызовите эту функцию, чтобы установить скорость по шине для узла. Значение bitrate должно быть в диапазоне 0..8 включительно. Любое другое значение приведет к использованию установки по умолчанию 0. Действительная скорость определяется константами в драйвере CAN. Эта функция должна быть вызвана перед mCO_InitAll().

Параметр:

unsigned char bitrate: значение для выбора скорости в диапазоне 0..8.

Пример см. во врезке, где приведено описание подпрограммы mCO_ProcessAllEvents.

unsigned char mCO_SetBaud(void)

Вызовите эту функцию, чтобы получить текущую настройку скорости, используемую этим узлом. Настройка будет возвращена как значение unsigned char. Точные значения скоростей, соответствующие настройке, определяются в драйвере CAN (см. раздел "Драйвер ECAN™").

Пример см. во врезке, где приведено описание подпрограммы mCO_ProcessAllEvents.

void mRPDOOpen(const unsigned char PDOnum)

Открывает конечную точку RPDO по её номеру. Здесь доступно только 4 объекта PDO. Обычно эта функция была бы вызвана в коммуникационном событии записи объекта RPDO. В сущности событие коммуникации записи объекта PDO генерируется, когда узел сети запрашивают на запуск коммуникаций PDO.

Параметр:

const unsigned char PDOnum: допустимый диапазон от 1 до 4. Это должно быть реальное число, не макрос.

Пример:

// Обработка события доступа к COB-ID

void CO_COMM_RPDO1_COBIDAccessEvent(void)
{
   switch (mCO_DictGetCmd())
   {
   case DICT_OBJ_READ:  // Чтение объекта.
                        // Трансляция формата MCHP COB в формат CANopen COB:
      mTOOLS_MCHP2CO(mRPDOGetCOB(1));
      // Возврат COB-ID
      *(unsigned long *)(uDict.obj->pReqBuf) = mTOOLS_GetCOBID();
      break;
   case DICT_OBJ_WRITE: // Запись объекта.
                        // Трансляция COB в формат MCHP:
      mTOOLS_CO2MCHP(*(unsigned long *)(uDict.obj->pReqBuf));
      // Если это запрос остановки PDO:
      if ((*(UNSIGNED32 *)(&mTOOLS_GetCOBID())).PDO_DIS)
      {
         // И если принятый COB соответствует сохраненному COB и типу, то закрыть
         if (!((mTOOLS_GetCOBID() ^ mRPDOGetCOB(1)) & 0xFFFFEFFF))
         {
            // Но закрыть только если конечная точка PDO была открыта
            if (mRPDOIsOpen(1))
            {
               mRPDOClose(1);
            }
            // Показать локальному объекту, что этот PDO запрещен
            (*(UNSIGNED32 *)(&mRPDOGetCOB(1))).PDO_DIS = 1;
         }
         else
         {
            mCO_DictSetRet(E_PARAM_RANGE);   //ошибка
         }
      }
      // Иначе если RPDO не открыт, то запустить RPDO
      else
      {
         // И если принятый COB соответствует сохраненному COB и типу, то откроем
         if (!((mTOOLS_GetCOBID() ^ mRPDOGetCOB(1)) & 0xFFFFEFFF))
         {
            // но откроем только елси конечная точка PDO была закрыта
            if (!mRPDOIsOpen(1))
            {
               mRPDOOpen(1);
            }
            // Показать локальному объекту, что этот PDO разрешен
            (*(UNSIGNED32 *)(&mRPDOGetCOB(1))).PDO_DIS = 0;
         }
         else
         {
            mCO_DictSetRet(E_PARAM_RANGE);   //ошибка
         }
      }
      break;
   }
}

BOOL mRPDOIsOpen(const unsigned char PDOnum)

Опрашивает, открыт ли RPDO. Обычно это должно быть вызвано в событии объекта коммуникаций PDO.

Параметр:

const unsigned char PDOnum: допустимый диапазон от 1 до 4. Это должно быть реальное число, не макрос.

Возвращаемые значения:

TRUE: RPDO открыт и принимает сообщения.
FALSE: RPDO закрыт и не принимает сообщения.

Пример см. во врезке с описанием функции mRPDOOpen.

void mRPDOClose(const unsigned char PDOnum)

Закрывает конечную точку RPDO. Обычно это должно быть вызвано в событии объекта коммуникаций PDO.

Параметр:

const unsigned char PDOnum: допустимый диапазон от 1 до 4. Это должно быть реальное число, не макрос.

Пример см. во врезке с описанием функции mRPDOOpen.

BOOL mRPDOnIsGetRdy(const unsigned char PDOnum)

Эта функция запрашивает у Менеджера Коммуникаций, был ли принят новый PDO по указанному номеру.

Параметр:

const unsigned char PDOnum: допустимый диапазон от 1 до 4. Это должно быть реальное число, не макрос.

Возвращаемые значения:

TRUE: данные были приняты и готовы к обработке.
FALSE: данные не были пока приняты.

Пример:

void DemoProcessEvents(void)
{
   unsigned char change;
   unsigned char rise;
   unsigned char fall;
   
   // Прочитать ножки входного порта
   (*(UNSIGNED8 *)uLocalXmtBuffer).bits.b0 = PORTBbits.RB5;
   (*(UNSIGNED8 *)uLocalXmtBuffer).bits.b1 = PORTBbits.RB4;
   // Определить, поменялось ли значение на них
   change = uIOinDigiInOld ^ uLocalXmtBuffer[0];
   // Определить, были ли события нарастания
   rise = (uIOinIntRise & change) & uLocalXmtBuffer[0];
   // Определить, были ли события спада
   fall = (uIOinIntFall & change) & ~uLocalXmtBuffer[0];
   // Определить, были ли события изменения
   change = (uIOinIntChange & change);
   // Присвоить текущее значение старому
   uIOinDigiInOld = uLocalXmtBuffer[0];
   // Если любое из этого верно, то показать условие прерывания
   if (uIOinIntEnable & (change | rise | fall))
      uDemoState.bits.b1 = 1;
   if (uDemoState.bits.b1)
   {
      switch (uDemoSyncSet)
      {
      case 0:     // Не циклическая синхронная передача.
         // Установка флага синхронной передачи
         uDemoState.bits.b2 = 1;
         break;
      case 254:   // Асинхронная передача
      case 255:
         // Установка флага асинхронной передачи
         uDemoState.bits.b0 = 1;
         break;
      }
   }
   // Если готовы к передаче
   if (mTPDOIsPutRdy(1) && uDemoState.bits.b0)
   {
      // Сказать стеку, что данные загружены для передачи:
      mTPDOWritten(1);
      // Сброс любых синхронных или асинхронных флагов:
      uDemoState.bits.b0 = 0;
      uDemoState.bits.b1 = 0;
   }
   // Если какие-либо данные были приняты
   if (mRPDOIsGetRdy(1))
   {
      // Записать первый байт буфера
      LATD = uLocalRcvBuffer[0];
      // Чтение PDO, освободить драйвер для приема других данных
      mRPDORead(1);
   }
}

void mRPDORead(const unsigned char PDOnum)

Эта функция вызывается, чтобы показать Менеджеру Коммуникаций, что последнее принятое сообщение было прочитано и надлежащим образом обработано. Это позволяет Менеджеру Коммуникаций принять другое сообщение PDO от драйвера. Приложение должно просто сделать копию данных или даже обработать данные на лету.

const unsigned char PDOnum: допустимый диапазон от 1 до 4. Это должно быть реальное число, не макрос.

Пример см. во врезке с описанием функции mRPDOIsGetRdy.

void mRPDOSetCOB(const unsigned char PDOnum, unsigned long rpdoCOB)

Эта функция устанавливает RPDO COB-ID (параметр rpdoCOB), PDO указывается по номеру (параметр PDOnum, допустимый диапазон от 1 до 4). Это должно быть установлено перед открытием PDO. COB-ID должен быть представлен в стандартном формате Microchip (формат MCHP).

Параметры:

const unsigned char PDOnum: допустимый диапазон 1 .. 4. Это должно быть реальное число, не макрос.
unsigned long rpdoCOB: COB-ID принимаемый этим PDO.

Пример:

void DemoInit(void)
{
   // Порт D весь работает как выход
   LATD = 0;
   TRISD = 0;
   
   uDemoSyncSet = 255;
   
   uIOinFilter = 0;
   uIOinPolarity = 0;
   uIOinIntChange = 1;
   uIOinIntRise = 0;
   uIOinIntFall = 0;
   uIOinIntEnable = 1;
   
   uIOinDigiInOld = uLocalXmtBuffer[0] = 0;
   uLocalRcvBuffer[1] = uLocalXmtBuffer[1] = 0;
   uLocalRcvBuffer[2] = uLocalXmtBuffer[2] = 0;
   uLocalRcvBuffer[3] = uLocalXmtBuffer[3] = 0;
   uLocalRcvBuffer[4] = uLocalXmtBuffer[4] = 0;
   uLocalRcvBuffer[5] = uLocalXmtBuffer[5] = 0;
   uLocalRcvBuffer[6] = uLocalXmtBuffer[6] = 0;
   uLocalRcvBuffer[7] = uLocalXmtBuffer[7] = 0;
   // Преобразование в формат MCHP
   mTOOLS_CO2MCHP(mCOMM_GetNodeID().byte + 0xC0000180L);
   // Сохранение COB
   mTPDOSetCOB(1, mTOOLS_GetCOBID());
   // Преобразование в формат MCHP
   mTOOLS_CO2MCHP(mCOMM_GetNodeID().byte + 0xC0000200L);
   // Сохранение COB
   mRPDOSetCOB(1, mTOOLS_GetCOBID());
   // Установка указателя на буферы
   mTPDOSetTxPtr(1, (unsigned char *)(&uLocalXmtBuffer[0]));
   // Установка указателя на буферы
   mRPDOSetRxPtr(1, (unsigned char *)(&uLocalRcvBuffer[0]));
   // Установка длины
   mTPDOSetLen(1, 8);
}

unsigned long mRPDOGetCOB(const unsigned char PDOnum)

Эта функция возвращает COB-ID, используемый в настоящее время объектом RPDO.

Параметр:

const unsigned char PDOnum: допустимый диапазон 1 .. 4. Это должно быть реальное число, не макрос.

Пример см. во врезке с описанием функции mRPDOOpen.

unsigned char mRPDOGetLen(const unsigned char PDOnum)

Вовзращает длину последнего принятого PDO (длина сообщения, допустимый диапазон 0..8).

Параметр:

const unsigned char PDOnum: допустимый диапазон 1 .. 4. Это должно быть реальное число, не макрос.

unsigned char * mRPDOGetRxPtr(const unsigned char PDOnum)

Эта функция возвращает указатель на локальный буфер приема. Указатель должен быть установлен перед открытием коммуникаций с конечной точкой. Когда коммуникации открыты, то все сообщения будут сохранены по месту, на которое ссылается этот указатель.

Параметр:

const unsigned char PDOnum: допустимый диапазон 1 .. 4. Это должно быть реальное число, не макрос.

void mRPDOSetRxPtr(const unsigned char PDOnum, unsigned char *pRXBUF)

Эта функция устанавливает указатель на локальный буфер приема. Этот указатель должен быть установлен перед открытием коммуникаций с конечной точкой. Когда коммуникации открыты, то все сообщения будут сохранены по месту, на которое ссылается этот указатель.

Параметры:

const unsigned char PDOnum: допустимый диапазон 1 .. 4. Это должно быть реальное число, не макрос.
unsigned char *pRXBUF: буфер для сообщений (размер не менее 8 байт).

Пример см. во врезке с описанием функции mRPDOSetCOB.

void mTPDOnOpen(const unsigned char PDOnum)

Открывает конечную точку TPDO. Здесь доступно только 4 объекта PDO. Обычно эта функция должна быть вызвана с объектом коммуникации TPDO при событии записи объекта. В сущности событие объекта коммуникаций PDO генерируется, когда узел сети запрашивает запуск коммуникаций PDO.

Параметр:

const unsigned char PDOnum: допустимый диапазон 1 .. 4. Это должно быть реальное число, не макрос.

Пример:

// Обработка событий доступа к COB-ID

void CO_COMM_TPDO1_COBIDAccessEvent(void)
{
   switch (mCO_DictGetCmd())
   {
   case DICT_OBJ_READ:     // Чтение объекта
      // Трансляция COB формата MCHP в COB формата CANopen
      mTOOLS_MCHP2CO(mTPDOGetCOB(1));
      // Возврат COBID
      *(unsigned long *)(uDict.obj->pReqBuf) = mTOOLS_GetCOBID();
      break;
   case DICT_OBJ_WRITE:    // Запись объекта
      // Трансляция COB в формат MCHP
      mTOOLS_CO2MCHP(*(unsigned long *)(uDict.obj->pReqBuf));
      // Если был запрос остановить PDO
      if ((*(UNSIGNED32 *)(&mTOOLS_GetCOBID())).PDO_DIS)
      {
         // И если принятый COB совпадает с сохраненным COB и типом, то закрываем
         if (!((mTOOLS_GetCOBID() ^ mTPDOGetCOB(1)) & 0xFFFFEFFF))
         {
            // Но закрывает только если конечная точка PDO была открыта
            if (mTPDOIsOpen(1))
            {
               mTPDOClose(1);
            }
            // Показать локальному объекту, что этот PDO запрещен
            (*(UNSIGNED32 *)(&mTPDOGetCOB(1))).PDO_DIS = 1;
         }
         else
         {
            mCO_DictSetRet(E_PARAM_RANGE);   //Ошибка
         }
      }
      // Иначе если TPDO не открыт, то запускаем TPDO
      else
      {
         // И если принятый COB совпадает с сохраненным COB и типом, то открываем
         if (!((mTOOLS_GetCOBID() ^ mTPDOGetCOB(1)) & 0xFFFFEFFF))
         {
            // Но открываем только если конечная точка PDO была закрыта
            if (!mTPDOIsOpen(1))
            {
               mTPDOOpen(1);
            }
            // Показать локальному объекту, что этот PDO разрешен
            (*(UNSIGNED32 *)(&mTPDOGetCOB(1))).PDO_DIS = 0;
         }
         else
         {
            mCO_DictSetRet(E_PARAM_RANGE);   //Ошибка
         }
      }
      break;
   }
}

BOOL mTPDOIsOpen(const unsigned char PDOnum)

Опрашивает, открыт ли TPDO. Обычно эта функция должна вызываться в событии коммуникаций объекта PDO.

Параметр:

const unsigned char PDOnum: допустимый диапазон 1 .. 4. Это должно быть реальное число, не макрос.

Возвращаемые значения:

TRUE: Менеджер Коммуникаций готов принять новые данные.
FALSE: Менеджер Коммуникаций занят передачей предыдущего сообщения.

Пример см. во врезке с описанием функции mTPDOOpen().

void mTPDOClose(const unsigned char PDOnum)

Закрывает конечную точку TPDO. Обычно эта функция должна быть вызвана в событии объекта коммуникаций PDO.

Параметр:

const unsigned char PDOnum: допустимый диапазон 1 .. 4. Это должно быть реальное число, не макрос.

Пример см. во врезке с описанием функции mTPDOOpen().

BOOL mTPDOIsPutRdy(const unsigned char PDOnum)

Эта функция опрашивает Менеджер Коммуникаций, доступен ли слот для передачи PDO. Эта функция вернет true, если Менеджер готов принять сообщение для отправки по шине.

Параметр:

const unsigned char PDOnum: допустимый диапазон 1 .. 4. Это должно быть реальное число, не макрос.

Возвращаемые значения:

TRUE: Менеджер Коммуникаций готов принять новые данные.
FALSE: Менеджер Коммуникаций занят передачей предыдущего сообщения.

Пример см. во врезке с описанием функции mRPDOIsGetRdy.

void mTPDOWritten(const unsigned char PDOnum)

Показывает Менеджеру Коммуникаций, что сообщение для передачи было загружено. Это позволяет Менеджеру Коммуникаций поставить сообщение в очередь для передачи. Функция события CO_PDOTXFinEvent() вызывается, когда сообщение помещается на шину.

Параметр:

const unsigned char PDOnum: допустимый диапазон 1 .. 4. Это должно быть реальное число, не макрос.

Пример см. во врезке с описанием функции mRPDOIsGetRdy.

void mTPDOSetCOB(const unsigned char PDOnum, unsigned long tpdoCOB)

Эта функция устанавливает TPDO COB-ID. Она должна быть вызвана перед передачей TPDO. COB-ID должен быть в стандартном формате Microchip.

Параметры:

const unsigned char PDOnum: допустимый диапазон 1 .. 4. Это должно быть реальное число, не макрос.
unsigned long tpdoCOB: COB-ID для передачи.

Пример см. во врезке с описанием функции mRPDOSetCOB.

unsigned long mTPDOnGetCOB(const unsigned char PDOnum)

Эта функция возвращает COB-ID, используемый в настоящее время объектом TPDO.

Параметр:

const unsigned char PDOnum: допустимый диапазон 1 .. 4. Это должно быть реальное число, не макрос.

Пример см. во врезке с описанием функции mRPDOSetCOB.

unsigned long mTPDOnSetLen(const unsigned char PDOnum, unsigned char length)

Эта функция устанавливает длину данных TPDO. Длина (length) должна быть в диапазоне от 0 до 8.

Параметры:

const unsigned char PDOnum: допустимый диапазон 1 .. 4. Это должно быть реальное число, не макрос.
unsigned char length: длина PDO, должна быть в диапазоне 0 .. 8.

Пример см. во врезке с описанием функции mRPDOSetCOB.

unsigned char * mTPDOGetTxPtr(const unsigned char PDOnum)

Эта функция получает указатель на использующийся в настоящее время локальный буфер передачи. При передаче все сообщения будут переданы из места, на которое ссылается этот указатель.

Параметр:

const unsigned char PDOnum: допустимый диапазон 1 .. 4. Это должно быть реальное число, не макрос.

void mTPDOnSetTxPtr(const unsigned char PDOnum)

Эта функция устанавливает указатель на локальный буфер передачи. При передаче все сообщения будут переданы из места, на которое ссылается этот указатель.

Параметр:

const unsigned char PDOnum: допустимый диапазон 1 .. 4. Это должно быть реальное число, не макрос.

Пример см. во врезке с описанием функции mRPDOIsGetRdy.

void CO_PDOnLSTimerEvent(void)

Это функция обратного вызова (callback) события таймера. Она вызывается с интервалом 1 мс, если объект PDO разрешен. Обычно приложение должно использовать это функции для таймера события PDO, как это указано в стандарте CANopen.

void CO_PDOnTxFinEvent(void)

Это callback-функция события завершения передачи. Это событие генерируется, когда сообщение, которое было поставлено в очередь на передачу, было отправлено по шине CAN.

void CO_COMMSyncEvent(void)

Это единственное событие, которое генерирует объект SYNC. Это событие генерируется, когда принято сообщение SYNC, что используется для синхронизации обработки PDO.

Ниже показан простой пример функции обработки переменной синхронного типа PDO, которая по своей природе является циклической. Тип переменной задается в PDO Type (параметр коммуникаций TPDO по sub-индексу 2), который должен быть в диапазоне 1 .. 240 включительно.

void CO_COMMSyncEvent(void)
{
   // Обработка только если синхронный режим
   if ((uDemoSyncSet == 0) && (uDemoState.bits.b2))
   {
      // Сброс синхронной передачи и переход к асинхронной передаче
      uDemoState.bits.b2 = 0;
      uDemoState.bits.b0 = 1;
   }
   else if ((uDemoSyncSet >= 1) && (uDemoSyncSet <= 240))
   {
      // Подстройка счетчика синхронизации
      uDemoSyncCount--;
      // Если наступило время генерации синхронного сообщения:
      if (uDemoSyncCount == 0)
      {
         // Сброс счетчика синхронизации
         uDemoSyncCount = uDemoSyncSet;
         // Запуск передачи PDO
         uDemoState.bits.b0 = 1;
      }
   }
}

void mSYNC_SetCOBID(unsigned long SYNC_COB)

Эта функция используется для установки COB-ID объекта SYNC. Она должна быть вызвана как минимум 1 раз перед инициализацией, чтобы правильно установить COB-ID в firmware системы.

Параметр:

unsigned long SYNC_COB: значение COB-ID в формате Microchip.

Пример см. во врезке с описанием функции mCO_ProcessAllEvents.

unsigned long mSYNC_GetCOBID(void)

Эта функция используется, чтобы получить COB-ID используемый в настоящее время объектом SYNC.

Возвращаемое значение:

unsigned long SYNC_COB: значение COB-ID в формате Microchip (MCHP).

void mNMT_Start(void)

Вызовите эту функцию для запуска коммуникаций, которые были остановлены. Обычно функция автоматически вызывается подпрограммами обслуживания NMT в результате поступления запроса NMT от мастера, чтобы установить подходящее состояние узла.

void mNMT_Stop(void)

Вызовите эту функцию для остановки узла, который находился в состоянии Operational или Pre-operational. Обычно функция автоматически вызывается подпрограммами обслуживания NMT в результате поступления запроса NMT от мастера, чтобы установить подходящее состояние узла.

void mNMT_GotoPreopState(void)

Вызовите эту функцию, чтобы перевести узел сети в состояние Pre-operational. Обычно функция автоматически вызывается подпрограммами обслуживания NMT в результате поступления запроса NMT от мастера, чтобы установить подходящее состояние узла.

void mNMT_GotoOperState(void)

Вызовите эту функцию, чтобы перевести узел сети в состояние Operational. Обычно функция автоматически вызывается подпрограммами обслуживания NMT в результате поступления запроса NMT от мастера, чтобы установить подходящее состояние узла.

BOOL mNMT_StateIsStopped(void)

Позволяет определить, находится ли сейчас узел в остановленном состоянии.

Возвращаемые значения:

TRUE: если узел в состоянии STOPPED.
FALSE: если узел в состоянии PREOPERATIONAL или OPERATIONAL.

BOOL mNMT_StateIsOperational(void)

Позволяет определить, находится ли сейчас узел в рабочем (Operational) состоянии.

Возвращаемые значения:

TRUE: если узел в состоянии OPERATIONAL.
FALSE: если узел в состоянии STOPPED или PREOPERATIONAL.

BOOL mNMT_StateIsPreOperational(void)

Позволяет определить, находится ли сейчас узел в состоянии Pre-Operational.

Возвращаемые значения:

TRUE: если узел в состоянии PREOPERATIONAL.
FALSE: если узел в состоянии STOPPED или OPERATIONAL.

void CO_NMTStateChangeEvent(void)

Эта callback-функция вызывается, когда состояние системы меняется при поступлении запроса NMT.

void CO_NMTResetEvent(void)

Эта callback-функция вызывается, когда пришел запрос на сброс коммуникаций. После обработки этого события коммуникации автоматически сбрасываются.

void CO_NMTAppResetRequest(void)

Эта callback-функция вызывается, когда пришел запрос на сброс приложения. Как будет обработан этот запрос - зависит от дизайна приложения. После обработки этого события будет сгенерировано событие CO_COMMResetEvent(). Коммуникации автоматически сбрасываются после обработки события CO_COMMResetEvent().

void mNMTE_SetHeartBeat(unsigned long HeartBeat)

Вызовите эту функцию для установки Heartbeat. Параметр Heartbeat указывается как unsigned long в формате стандарта CANopen. Он устанавливается перед инициализацией коммуникаций.

unsigned long mNMTE_GetHeartBeat(void)

Вызовите эту функцию, чтобы получить текущее установленное значение Heartbeat (число unsigned long в формате стандарта CANopen).

void mNMTE_SetGuardTime(unsigned long GuardTime)

Вызовите эту функцию для установки guard time. Параметр GuardTime это число unsigned long в формате стандарта CANopen. Он устанавливается перед инициализацией коммуникаций.

unsigned long mNMTE_GetGuardTime(void)

Вызовите эту функцию, чтобы получить текущее установленное значение guard time (число unsigned long в формате стандарта CANopen).

void mNMTE_SetLifeFactor(unsigned char LifeFactor)

Используйте эту функцию, чтобы установить значение множителя времени жизни (параметр LifeFactor).

unsigned char mNMTE_GetLifeFactor(void)

Используйте эту функцию, чтобы получить значение множителя времени жизни.

void CO_NMTENodeGuardErrEvent(void)

Эта callback-функция вызывается, когда происходит событие защиты узла (node guard event). Это момент времени, когда не было принято событие node guard в течение установленного времени жизни lifetime (результат умножения life time factor и guard time). Как будет это событие обработано - зависит от приложения.

void mCO_DictObjectRead(DICT_OBJ myObj)

Эта функция читает объект, определенный через myObj. Чтобы это использовать, информация объекта должна быть сохранена локально как структура DICT_OBJ, когда она передается в функцию mCO_DictObjectRead(). Внутри используется только ссылка.

В структуре DICT_OBJ находится необходимая информация, которая должна быть получена из объекта. Некоторая часть этой информации должна быть предоставлена вызывающей функцией, и другая информация должна быть предоставлена из OD. Функция mCO_DictObjectDecode() должна быть вызвана перед вызовом mCO_DictObjectRead(), чтобы получить доступ и информацию ссылки, сохраненные в OD. Другая информация должна быть предоставлена пользователем. В таблице 12 описана структура и источник информации для каждого элемента.

Таблица 12. Структура DICT_OBJ.

Параметры:

DICT_OBJ myObj: структура объекта, показанная в таблице 12, см. врезку с описанием функции mCO_DictObjectRead.

Возвращаемые значения отсутствуют. Используйте mCO_DictGetRet() для получения кода ошибки.

Пример:

void MyFunc(void)
{
   DICT_OBJ myLocalObj;
   unsigned char localArray[20];
   // Указание объекта
   myLocalObj.index = 0x1008L;
   myLocalObj.subindex = 0x00;
   // Получение информации, сохраненной в словаре OD
   mCO_DictObjectDecode(myLocalObj);
   // Указать локальное пространство, и что нужно читать данные
   myLocalObj.pReqBuf = localArray;
   myLocalObj.reqLen = 0x8;
   myLocalObj.reqOffst = 0x0;
   // Чтение объекта
   mCO_DictObjectRead(myLocalObj);
}

void mCO_DictObjectWrite(DICT_OBJ myObj)

Эта функция записывает объект, заданный через myObj. Чтобы это использовать, информация объекта должна быть сохранена локально как структура DICT_OBJ и затем передана в функцию mCO_DictObjectWrite(). Внутри используется только ссылка.

Параметр:

DICT_OBJ myObj: структура объекта, показанная в таблице 12, см. врезку с описанием функции mCO_DictObjectRead.

Возвращаемые значения отсутствуют. Используйте mCO_DictGetRet() для получения кода ошибки.

Базовое использование функции подобно тому, как показано в примере врезки описания функции mCO_DictObjectRead.

void mCO_DictObjectDecode(DICT_OBJ myObj)

Эта функция используется для заполнения любой статической информации для определенного объекта, который находится в OD. Объект задается через myObj, который должен быть определен локально и передан в эту функцию. Функция возьмет индекс и sub-индекс для поиска объекта в OD. Объект найден, то указатель, длина и некоторая управляющая информация будет загружена в структуру myObj (см. таблицу 12 во врезке с описанием функции mCO_DictObjectRead). Будет возвращена информация статуса, и она может быть получена вызовом функции mCO_DictGetRet().

Параметр:

DICT_OBJ myObj: структура объекта, как она определена в таблице 12 (см. врезку с описанием функции mCO_DictObjectRead).

Возвращаемое значение отсутствует. Используйте mCO_DictGetRet() для получения кода ошибки.

Базовое использование функции подобно тому, как показано в примере врезки описания функции mCO_DictObjectRead.

enum _DICT_OBJECT_REQUEST mCO_DictGetCmd(void)

Эта функция используется при получении команды для объекта. Имеется только 3 команды: DICT_OBJ_INFO, DICT_OBJ_READ и DICT_OBJ_WRITE.

Возвращаемые значения:

DICT_OBJ_INFO: чтение управляющей информации объекта.
DICT_OBJ_READ: чтение объекта.
DICT_OBJ_WRITE: запись объекта.

Как использовать функцию см. в Примере 9 секции "Функционально определенный объект".

unsigned char mCO_DictGetRet(void)

Эта функция используется для получения статуса возврата операции OD.

Возвращаемые значения: все они перечислены в таблице 11 (см. выше секцию "Функционально определенный объект").

void mCO_DictSetRet(unsigned char retVal)

Эта функция используется для установки статуса возврата операции OD. Это используется только внутри функции обработки объекта.

Параметр:

unsigned char retVal: статус возврата запроса объекта. Все возможные значения этого параметра перечислены в таблице 11 (см. выше секцию "Функционально определенный объект").

Как использовать функцию см. в Примере 9 секции "Функционально определенный объект".

void mCANEventManager(void)

Это функция обработчика события. Все поставленные в очередь события обрабатываются внутри этой функции. Эта функция вызывается из стека CANopen, когда вызывается CO_ProcessAllEvents.

void mCANReset(unsigned char CANBitRate)

Эта функция сбрасывает коммуникации CAN, и устанавливает подходящую скорость по шине. Эта функция вызывается из стека CANopen, когда получен запрос сброса либо от приложения, либо от мастера NMT.

void mCANOpenComm(void)

Эта функция открывает коммуникации CAN, её следует рассматривать как запрос. В зависимости от состояния активности шины, коммуникации могут быть не открыты немедленно.

void mCANCloseComm(void)

Эта функция закрывает коммуникации CAN.

BOOL mCANIsCommOpen(void)

Эта функция может использоваться для опроса драйвера: были или нет открыты коммуникации.

Возвращаемые значения:

TRUE: коммуникации открыты.
FALSE: коммуникации закрыты.

void mCANErrIsOverFlow(void)

Эта функция используется, чтобы опросить драйвер: было ли событие переполнения буфера приема. Если найдено событие переполнения, то оно может быть удалено вызовом функции mCANErrClearOverFlow. Когда случилось условие переполнения, то одно или большее количество сообщений было потеряно. Как обработать эту ситуацию - зависит от приложения; спецификация CANopen не требует определенного метода обработки этого условия.

Возвращаемые значения:

TRUE: было переполнение буфера приема.
FALSE: не было переполнения буфера приема.

void mCANErrClearOverFlow(void)

Удаляет информацию об условии переполнения буфера приема.

void mCANSetBitRate(unsigned char CANBitRate)

Эта функция устанавливает текущее значение скорости бит (bitrate) шины CAN. Скорость не изменяется немедленно, это в действительности ставится в очередь драйвера, пока драйвер и аппаратура CAN не будут готовы принять изменение. Обычно эта функция вызывается только 1 раз в момент старта.

Параметр:

unsigned char CANBitRate: здесь может быть любое значение; однако считаются действительными только значения в диапазоне 0 .. 8. Все другие значения автоматически приведут к установке скорости по умолчанию, которая задается опцией 0. Все 9 опций скорости определены в файле CO_DEFS.DEF.

unsigned char mCANGetBitRate(void)

Эта функция вернет текущий битрейт, используемый драйвером.

Возвращаемые значения:

unsigned char: текущий битрейт. Достоверными будут только значения 0 .. 8; однако функция может вернуть другие значения, если в вызов mCANSetBitRate() было передано значение, отличающееся от диапазона 0 .. 8.

void mCANOpenMessage(unsigned char MsgTyp, unsigned long COBID, unsigned char hRet)

Эта функция сканирует доступные почтовые ящики в поиске открытого слота. Должен быть передан идентификатор CAN вместе с уникальным ненулевым дескриптором (handle) к этому идентификатору. Если найден слот, то все сообщения, содержащие предоставленный идентификатор CAN, будут приняты, и этот дескриптор будет использоваться для идентификации сообщения. В вызывающий код также будет возвращен дескриптор, если слот найден; иначе будет возвращено 0. Вызывающая функция должна хранить дескриптор, если конечная точка была освобождена позже без сброса.

Идентификатор CAN добавляется, но не активируется, пока шина и драйвер не будут готовы. В будущих модулях CAN эта функциональность очереди может быть удалена, в зависимости от доступной аппаратной поддержки.

Параметры:

unsigned char MsgTyp: уникальный дескриптор (handle) для идентификатора. Должен быть ненулевым.
unsigned long COBID: идентификатор CAN допустимого сообщения.

Возвращаемое значение:

unsigned char hRet: статус возврата. Здесь будет 0 либо дескриптор (handle).

void mCANCloseMessage(unsigned char hMsg)

Эта функция сканирует почтовые ящики в поиске дескриптора (handle). Если найден, то идентификатор CAN удаляется из списка приема.

Происходит только постановка в очередь запроса удаления идентификатора CAN из списка. Таким образом, сообщения все еще могут приниматься, пока драйвер не будет в состоянии полностью удалить идентификатор CAN из аппаратуры. В будущих модулях CAN эта функциональность очереди может быть удалена, в зависимости от доступной аппаратной поддержки.

Параметр:

unsigned char hMsg: дескриптор (handle) для сообщения.

void mCANIsGetRTR(void)

Эта функция опрашивает драйвер на условие RTR текущего сообщения. Перед этим запросом должна быть вызвана функция mCANIsGetReady для установки текущего сообщения.

void mCANIsGetReady(void)

Эта функция определяет событие приема. Если оно найдено, то связанный дескриптор (handle) помещается в буфер приема, во внутренний регистр, к которому можно получить доступ через mCANFetchRetStat. Иначе будет возвращен 0. Если ожидает допустимое сообщение, то оно должно быть обработано перед повторным вызовом этой функции.

Подразумевается доступ к буферу на последовательных вызовах приема, т. е. не требуется дескриптор для связанных функций чтения. Например, вызовы функций mCANGetDataLen() и mCANGetDataByten() подразумевают, что запрашиваются наиболее текущие принятые данные сообщения.

void mCANReadMessage(void)

Вызов этой функции показывает драйверу, что текущее сообщение было обработано, и драйвер теперь освобождает используемый буфер для нового сообщения. Функция mCANIsGetReady должна быть вызвана перед этим запросом, для установки текущего сообщения.

unsigned char * mCANGetPtrRxCOB(void)

Эта функция возвратит указатель на текущий идентификатор. Он также указывает на все сообщение, сохраненное в формате Microchip.

Возвращаемое значение:

unsigned char *: указатель на принятый идентификатор CAN.

unsigned char * mCANGetPtrRxData(void)

Эта функция вернет указатель на текущие данные.

unsigned char mCANGetDataLen(void)

Эта функция вернет длину текущего сообщения или запроса RTR.

unsigned char mCANGetDataByten(void)

Представляет 8 функций, где суффикс n может быть значениями от 0 до 7. Каждая из этих функций вернет соответствующий байт данных принятого сообщения.

void mCANIsPutReady(putHndl)

Эта функция сканирует в поиске доступного выходного буфера. В случае успеха дескриптор, переданный в функцию, будет такой же, что и возвращенный; иначе будет возвращен 0. Для получения возвращенного значения должна быть вызвана функция mCANFetchRetStat.

Параметр:

unsigned char putHndl: дескриптор (handle) сообщения.

void mCANIsPutFin(void)

Эта функция опрашивает драйвер на наличие любого сообщения, которое было помещено на шину, и возвращает дескриптор (handle) для сообщения, которое было отправлено. Для получения дескриптора этого сообщения должна быть вызвана функция mCANFetchRetStat.

Эта функция должна быть вызвана только один раз для индикации передачи. Вызов этой функции второй раз после получения индикации может не возвратить тот же самый дескриптор.

void mCANSendMessage(void)

Эта функция используется, чтобы показать драйверу, что данные, длина и идентификатор CAN были загружены и готовы к отправке.

unsigned char * mCANGetPtrTxCOB(void)

Эта функция вернет указатель на буфер идентификатора передачи CAN.

unsigned char * mCANGetPtrTxData(void)

Эта функция вернет указатель на буфер передачи данных.

void mCANPutDataLen(unsigned char CANlen)

Эта функция устанавливает длину данных или длину запроса RTR.

void mCANPutDataByten(unsigned char CANDat)

Это имя представляет 8 функций, где суффикс n может быть значением от 0 до 7. Каждая из этих функций может использоваться для установки соответствующего байта для отправки.

Параметр:

unsigned char CANDat: байт данных.

unsigned char mCANFetchRetStat(void)

Эта функция используется для получения статуса операции тех функций, которые такой статус возвращают. В описании функций указано, возвращают ли они статус.

Возвращаемое значение:

unsigned char: статус последней операции.