Handbuch. RS232-IO-Modul

Transkript

1 Handbuch RS232-IO-Modul Version 1.2

2 Versionsübersicht Version Erscheinungsdatum Kommentar September 2011 Ursprungsversion November 2011 Checksummen-Berechnung verändert, Anschlussbelegung hinzugefügt Februar 2012 Reset-, DisableChecksum- und GetFirmwareVersion- Befehle hinzugefügt RoHS COMPLIANT

3 Dieses Produkt entspricht der EG-Richtlinie 2002/95/EG zur Beschränkung der Verwendung bestimmter gefährlicher Stoffe in Elektro- und Elektronikgeräten. Inhaltsverzeichnis 1. Bootloader Anschlussbelegung Kommunikations-Protokoll Befehlsübersicht Befehle Antworten...12 A. Berechnung der CRC-Checksumme...14

4 1. Bootloader Das RS232-IO-Modul verfügt über einen integrierten Bootloader, über den neue Firmware auf das Modul geladen werden kann. Die Aktivierung des Bootloaders erfolgt über den EnableBootloader-Befehl. Die neue Firmware wird nach der Aktivierung des Bootloaders über den COM-Port eingespielt. Die Einstellungen für den COM-Port sind die gleichen wie im normalen Betrieb. Nach der Aktivierung muss zunächst der Flash-Speicher gelöscht werden. Hierfür muss der ASCII-String cf gesendet werden. Der Bootloader antwortet mit Flash erased.\n. Anschließend muss der String f gesendet werden, um dem Bootloader in den Wartezustand zu versetzen, in dem er auf die neue Firmware-Datei wartet. Der Bootloader antwortet nach Empfang des Zeichens mit dem String Waiting for firmware file.\n. Anschließend wird die Firmware-Datei Zeichen für Zeichen übertragen. Während der Übertragung wird nach und nach der String 0%...100%\n übertragen, der gleichzeitig den Fortschritt des Uploads anzeigt. Tritt während der Übertragung ein Fehler auf, meldet der Bootloader Checksum error.\n und bricht den Upload ab. Nach der erfolgreichen Programmierung kann der Bootloader durch Senden des Strings x verlassen werden. Nach der Bestätigung Bootloader exit.\n startet die Applikation. Unbekannte Befehle, die an den Bootloader gesendet werden werden mit?\n beantwortet.

5 2. Anschlussbelegung Spannungsversorgung: 12V DC (±20%), mindestens 0,1A Relaisausgänge: PWM-Ausgänge: Aus 1, Aus 2: Aus 3, Aus 4: max. 60V DC, 7A Open-Drain-Ausgänge, max. 24V DC, 2A Open-Drain-Ausgänge, max. 24V DC, 2A Push-Pull-Ausgänge, 3,3V, max. 20mA Ein 1 bis Ein 8: Eingänge, 0-5V Der 3,3V-Ausgang auf dem Erweiterungsstecker ist bis maximal 100mA belastbar Eingangsspannung Relais 1-A Relais 1-B Relais 2-A Relais 2-B Aus 1 Aus 2 PWM 1 PWM 2 PWM 3 PWM 4 +12V Masse 73mm Ø 4 3,2mm 3mm PWM15 PWM14 PWM13 PWM12 PWM11 PWM10 PWM9 PWM8 PWM7 PWM6 PWM5 +12V 61mm 17mm RS232 17mm

6 Pin Signal Pin Signal 1 +12V 2 Masse 3 Ein 1 4 Ein 2 5 Ein 3 6 Ein 4 7 Ein 5 8 Ein 6 9 Ein 7 10 Ein 8 11 Aus 3 12 Aus V3 14 Masse Erweiterungsstecker 3. Kommunikations-Protokoll Die Einstellungen der COM-Port-Verbindung sind der folgenden Tabelle zu entnehmen. Baudrate baud Start-Bits 1 Daten-Bits 8 Stopp-Bits 1 Parität-Bits 0 Flusskontrolle keine COM-Port-Einstellungen Jedes Paket vom PC zum RS232-IO-Modul und zurück besteht aus einem Längen- Byte, einem Befehls-Byte, Daten-Bytes (optional) und zwei Checksummen-Bytes. LEN CMD DATA LRC Sende- und Empfangspaket LEN: CMD: DATA: Länge des Pakets (CMD bis einschließlich LRC) Funktionscode Funktionsdaten

7 LRC: Checksumme (CRC16-Checksumme, Polynom x 16 +x 15 +x 2 +1, Startwert 0xFFFF, Berechnungsroutine in C im Anhang)

8 4. Befehlsübersicht Alle implementierten Befehle, über die der Mikrocontroller auf dem RS232-IO-Modul angesprochen werden kann, sind der folgenden Tabelle zu entnehmen. Befehl Funktionscode Funktionsdaten EnterBootloader 0x10 - GetLastError 0x11 - Reset 0x12 - DisableChecksum 0x13 - GetFirmwareVersion 0x14 - GetInputs 0x20 - SetRelais 0x21 Relaisname und Wert SetPWM 0x22 PWM-Name und Wert SetOutputs 0x23 Output-Name und Wert Befehlsübersicht Das RS232-IO-Modul antwortet auf jeden Befehl mit einem Funktionscode sowie eventuell folgenden zusätzlichen Daten-Bytes. Antwort Funktionscode Funktionsdaten OK 0xF0 - CommandUnknown 0xF1 - ChecksumError 0xF2 - ParameterOutOfRange 0xF3 - CommandCannotBeProcessed 0xF4 - WrongNumberOfParameters 0xF5 - Antworten-Übersicht

9 4.1. Befehle EnterBootloader Versetzt den Mikrocontroller in den Bootloader-Modus Beispiel: Befehl 0x03 0x10 0x6E 0x0A Antwort 0x03 0xF0 0x2D 0x88 Mikrocontroller wurde in den Bootloader-Modus versetzt. GetLastError Sendet den letzten Fehlercode zurück. Der Fehlercode kann auch 0xF0 sein, sofern der letzte Befehl (bis auf den GetLastError-Befehl) korrekt ausgeführt wurde. Beispiel: Befehl 0x03 0x11 0x6B 0x8A Antwort 0x03 0xF0 0x2D 0x88 Der letzte Befehl wurde korrekt ausgeführt. Reset Resettet den Mikrocontroller. Alle Ausgänge warden in den Ursprungszustand zurückgesetzt. Beispiel: Befehl 0x03 0x12 0x61 0x8A Antwort 0x03 0xF0 0x2D 0x88 Der Mikrocontroller wurde resettet. DisableChecksum Schaltet die Checksummen-Verifikation bis zum nächsten Reset aus. Dieser Befehl sollte nicht in Serien-Geräten verwendet werden sondern dient nur für eine

10 einfachere Entwicklung und das Testen neuer Befehle. Anstelle der tatsächlichen CRC16-Checksumme können einfach zwei beliebige Bytes übertragen werden, die Gesamtlänge des Paketes darf nicht verändert werden. Beispiel: Befehl 0x03 0x13 0x64 0x0A Antwort 0x03 0xF0 0x2D 0x88 Die Checksummen-Verifikation wurde ausgeschaltet. GetFirmwareVersion Liefert die Firmware-Version in zwei Bytes zurück. Beispiel: Befehl 0x03 0x14 0x75 0x8A Antwort 0x05 0xF0 0x00 0x02 0xEB 0xC8 Die aktuelle Firmware ist GetInputs Liefert den Status der Eingänge zurück. Eine 1 steht für einen geschlossenen Kontakt (Eingang liegt auf Masse), eine 0 einen offenen Kontakt. 0 (LSB) (MSB) Ein 1 Ein 2 Ein 3 Ein 4 Ein 5 Ein 6 Ein 7 Ein 8 Eingänge Beispiel: Befehl 0x03 0x20 0xCE 0x0A Antwort 0x04 0xF0 0x02 0x50 0x2A Eingang 2 ist geschlossen, alle anderen Eingänge sind offen. SetRelais Schließt oder öffnet einen Relais-Kontakt. Das erste Daten-Byte steht für das Relais (0 für Relais 1, 1 für Relais 2), das zweite Daten-Byte ist der neue Zustand des Relais (0 offen, alle anderen Werte geschlossen).

11

12 Beispiel: Befehl 0x05 0x21 0x00 0x01 0xB5 0xC6 Antwort 0x03 0xF0 0x2D 0x88 Relais 1 zieht an. SetPWM Verändert das Tastverhältnis der PWM-Kanäle. Das erste Daten-Byte steht für den PWM-Kanal (0-14 für PWM1 bis PWM15), das zweite gibt das Tastverhältnis von 0 bis 255 an (0 = 0%, 255 = 100%). Beispiel: Befehl 0x05 0x22 0x00 0xFF 0x8E 0x44 Antwort 0x03 0xF0 0x2D 0x88 Tastverhältnis von PWM1 ist 100%. SetOutputs Zieht einen Ausgangspin auf High (3,3V) oder Low (0V). Das erste Daten-Byte steht für den Ausgangspin (0 für Ausgang 1 bis 4 für Ausgang 5), das zweite Daten-Byte ist der neue Zustand des Ausgangs (0 bedeutet Low, alle anderen Werte High). Beispiel: Befehl 0x05 0x23 0x00 0x01 0x9E 0x46 Antwort 0x03 0xF0 0x2D 0x88 Ausgang 1 wird auf High gesetzt Antworten OK Befehl wurde korrekt verarbeitet.

13 CommandUnknown Unbekannter Befehl. ChecksumError Checksumme des letzten Befehls fehlerhaft. ParameterOutOfRange Die Werte der übergebenen Daten-Bytes sind außerhalb des gültigen Bereiches. CommandCannotBeProcessed Der Befehl kann zurzeit nicht verarbeitet werden, da ein anderer Befehl noch abgearbeitet wird oder die benötigte Hardware nicht angeschlossen ist. WrongNumberOfParameters Die Anzahl der Daten-Bytes entspricht nicht der erwarteten Anzahl für den entsprechenden Befehl.

14 Anhang A. Berechnung der CRC-Checksumme /** ****************************************************************************** crc16.c BUDELMANN Elektronik V1.0 09/10/2010 CRC16 routines (polynom x^16+x^15+x^2+1, seed 0xFFFF). ****************************************************************************** * * THE PRESENT FIRMWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS * WITH CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE * TIME. AS A RESULT, BUDELMANN ELEKTRONIK SHALL NOT BE HELD LIABLE FOR ANY * DIRECT, INDIRECT OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING * FROM THE CONTENT OF SUCH FIRMWARE AND/OR THE USE MADE BY CUSTOMERS OF THE * CODING INFORMATION CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS. * * <h2><center> COPYRIGHT 2010 BUDELMANN Elektronik</center></h2> */ CRC16_Private_Variables */ /* CRC values */ static const unsigned int CRC16_Table[256] = { 0x0000, 0x8005, 0x800F, 0x000A, 0x801B, 0x001E, 0x0014, 0x8011, 0x8033, 0x0036, 0x003C, 0x8039, 0x0028, 0x802D, 0x8027, 0x0022, 0x8063, 0x0066, 0x006C, 0x8069, 0x0078, 0x807D, 0x8077, 0x0072, 0x0050, 0x8055, 0x805F, 0x005A, 0x804B, 0x004E, 0x0044, 0x8041, 0x80C3, 0x00C6, 0x00CC, 0x80C9, 0x00D8, 0x80DD, 0x80D7, 0x00D2, 0x00F0, 0x80F5, 0x80FF, 0x00FA, 0x80EB, 0x00EE, 0x00E4, 0x80E1, 0x00A0, 0x80A5, 0x80AF, 0x00AA, 0x80BB, 0x00BE, 0x00B4, 0x80B1, 0x8093, 0x0096, 0x009C, 0x8099, 0x0088, 0x808D, 0x8087, 0x0082, 0x8183, 0x0186, 0x018C, 0x8189, 0x0198, 0x819D, 0x8197, 0x0192, 0x01B0, 0x81B5, 0x81BF, 0x01BA, 0x81AB, 0x01AE, 0x01A4, 0x81A1, 0x01E0, 0x81E5, 0x81EF, 0x01EA, 0x81FB, 0x01FE, 0x01F4, 0x81F1, 0x81D3, 0x01D6, 0x01DC, 0x81D9, 0x01C8, 0x81CD, 0x81C7, 0x01C2, 0x0140, 0x8145, 0x814F, 0x014A, 0x815B, 0x015E, 0x0154, 0x8151, 0x8173, 0x0176, 0x017C, 0x8179, 0x0168, 0x816D, 0x8167, 0x0162, 0x8123, 0x0126, 0x012C, 0x8129, 0x0138, 0x813D, 0x8137, 0x0132, 0x0110, 0x8115, 0x811F, 0x011A, 0x810B, 0x010E, 0x0104, 0x8101, 0x8303, 0x0306, 0x030C, 0x8309, 0x0318, 0x831D, 0x8317, 0x0312, 0x0330, 0x8335, 0x833F, 0x033A, 0x832B, 0x032E, 0x0324, 0x8321, 0x0360, 0x8365, 0x836F, 0x036A, 0x837B, 0x037E, 0x0374, 0x8371, 0x8353, 0x0356, 0x035C, 0x8359, 0x0348, 0x834D, 0x8347, 0x0342, 0x03C0, 0x83C5, 0x83CF, 0x03CA, 0x83DB, 0x03DE, 0x03D4, 0x83D1, 0x83F3, 0x03F6, 0x03FC, 0x83F9, 0x03E8, 0x83ED, 0x83E7, 0x03E2, 0x83A3, 0x03A6, 0x03AC, 0x83A9, 0x03B8, 0x83BD, 0x83B7, 0x03B2, 0x0390, 0x8395, 0x839F, 0x039A, 0x838B, 0x038E, 0x0384, 0x8381, 0x0280, 0x8285, 0x828F, 0x028A, 0x829B, 0x029E, 0x0294, 0x8291, 0x82B3, 0x02B6, 0x02BC, 0x82B9, 0x02A8, 0x82AD, 0x82A7, 0x02A2, 0x82E3, 0x02E6, 0x02EC, 0x82E9, 0x02F8, 0x82FD, 0x82F7, 0x02F2, 0x02D0, 0x82D5, 0x82DF, 0x02DA, 0x82CB, 0x02CE, 0x02C4, 0x82C1, 0x8243, 0x0246, 0x024C, 0x8249, 0x0258, 0x825D, 0x8257, 0x0252, 0x0270, 0x8275, 0x827F, 0x027A, 0x826B, 0x026E, 0x0264, 0x8261, 0x0220, 0x8225, 0x822F, 0x022A, 0x823B, 0x023E, 0x0234, 0x8231, 0x8213, 0x0216, 0x021C, 0x8219, 0x0208, 0x820D, 0x8207, 0x0202 }; /** */

15

16 CRC16_Private_Functions */ /** Fold a data byte into CRC16 value. crc Last CRC16 value data New data byte New CRC16 value */ unsigned int CRC16(unsigned int crc, unsigned char data) { return (crc << 8) ^ CRC16_Table[(crc >> 8) ^ data]; } /** */