Maxx GW4100

2022-03-22T07:36:41Z

Nbrandt: /* Applications */

= Quick Guide =

== Einleitung ==

Die IoTmaxx Gateway-Serie GW410x ermöglicht über ihre zahlreichen Schnittstellen ein Einfaches einsammeln und verarbeiten von Informationen mit einer sicheren Übertragung über das Mobilfunknetz.
Zur Inbetriebnahme ist eine SIM-Karte Ihres Mobilfunkbetreibers mit geeignetem Tarif erforderlich.

Bitte beachten Sie: Eine falsche PIN kann zur Sperrung der SIM-Karte führen. Halten Sie sicherheitshalber die Super-Pin bzw. PUK zur Freischaltung bereit.

'''Bitte legen Sie die SIM-Karte zunächst NICHT in das Gateway ein!'''

== Zur Inbetriebnahme des Gateways benötigen Sie: ==

* Eine LTE-Antenne mit SMA-Stecker
* Ein Netzteil mit einer Ausgangsspannung im Bereich von 10 bis 30V DC/>15W
* Ein Ethernet-Kabel
* Einen PC oder Laptop mit Ethernet-Anschluss und installiertem Browser
* Eine SIM-Karte im Formfaktor MINI-SIM (2ff)

== Montage der Antenne ==

Schrauben Sie die Antenne an den „GSM“-Anschluss des Gateways. Wenn Sie eine Antenne mit GPS-Signal benutzen, schließen Sie bitte den zweiten SMA-Stecker an den „GPS“-Anschluss an.

== Einlegen der SIM-Karte ==

Auf der Rückseite des Gateways befinden sich zwei Slots für SIM-Karten sowie ein Slot für eine Micro SD-Karte.
Der obige Slot ist für eine MINI-Sim (2ff), der darunter liegenden Slot für eine MICRO-SIM (3ff) vorbereitet.

'''Im Auslieferungszustand wird nur der Slot für eine MINI-Sim (2ff) unterstützt.'''

Stecken Sie bitte, wie in der Abbildung dargestellt, die SIM-Karte in den obersten Slot, bis diese einrastet.
Verwenden Sie gegebenenfalls ein flaches Werkzeug (z.B. Schraubenzieher) um die SIM einzuschieben.

[[Datei:GW4100x SIM SLOT.jpg| 150px |rahmenlos | SIM-Karten Slot]]

== Anschluss der Spannungsversorgung ==

Schließen Sie bitte das Netzteil an den Steckverbinder mit der „+ -“ Beschriftung an. Achten Sie auf die richtige Polarität. Das Gateway ist mit einem Verpolungsschutz ausgerüstet, bleibt aber bei falscher Polarität inaktiv.
Nach dem Einschalten des Netzteils leuchten während der Initialisierungsphase (ca. 5s) die LED A und LED B, die Power-LED leuchtet dauerhaft. Wenn die LED A und LED B erloschen sind, ist das Gerät betriebsbereit.

== Konfiguration des GW410x ==

Die Konfiguration des Gateways erfolgt über das integrierte Webinterface. Bitte gehen Sie wie folgt vor:

a. Verbinden Sie Ihren PC mit dem Ethernet-Kabel direkt mit der Ethernet-Schnittstelle (eth0). Das Gateway ist im Auslieferungszustand als DHCP Server konfiguriert, sodass Ihr PC automatisch eine IP-Adresse erhält.

b. Öffnen Sie einen Browser auf Ihrem PC und geben Sie die IP-Adresse 192.168.1.1:3000 in das Adressfeld ein.

c. Geben Sie im Anmeldefenster als Nutzername und Passwort jeweils „admin“ (ohne Anführungszeichen) ein und klicken Sie auf „LOGIN“.

d. Öffnen Sie den Menüpunkt „Wireless Network“. Tragen Sie hier unter „PIN“ die PIN-Nummer Ihrer SIM-Karte ein, sofern Sie die PIN-Abfrage Ihrer SIM-Karte nicht abgeschaltet haben. In diesem Fall kann das Feld leer bleiben.

e. Des Weiteren tragen Sie gegebenenfalls den APN und wenn gefordert den Usernamen und Passwort für die Authentifizierung der Datenübertragung in Ihrem Mobilfunknetz ein. Die Daten erhalten Sie von Ihrem Mobilfunkanbieter.

f. Bestätigen Sie Ihre Eingaben mit „SUBMIT“.

[[Datei:GW4100X WIRELESS NETWORK_3.jpg| 600px | rahmenlos | Wireless Network]]

g. Trennen Sie nun das Gateway vom Netzteil und legen jetzt die SIM-Karte wie beschrieben ein.

h. Verbinden Sie das Gateway wieder mit der Spannungsversorgung und prüfen Sie die erfolgreiche Einwahl und Verbindung zum Mobilfunknetz unter dem Menüpunkt „Network State“.

== Zustandssignalisierung ==

Der Betriebszustand der Mobilfunkverbindung der Gateway-Serie GW410x wird über die GSM Status LED wie im Folgenden beschrieben signalisiert.

{| class="wikitable"
! GSM Status LED !! Netzverbindung
|-
| Langsames Blinken (kurz EIN / lang AUS) || Netzsuche
|-
| Langsames Blinken (lang EIN / kurz AUS)|| Eingebucht, aber keine Datenverbindung
|-
| Schnelles Blinken (kurz EIN / kurz AUS) || Eingebucht und eine bestehende Datenverbindung
|}

= Konfiguration über WBM (Web Based Management) =

Die Konfiguration des maxx GW410x erfolgt über eine Webbrowser basierende Funktion. Hierfür müssen zunächst folgende Bedingungen erfüllt sein:

* Der PC, der zur Konfiguration des Gateways verwendet wird, verfügt über eine LAN-Schnittstelle.
* Auf dem PC ist ein Webbrowser installiert (z.B. Google Chrome, Mozilla Firefox, Microsoft Internet Explorer).
* Das Gateway ist mit einer Spannungsquelle verbunden.

== Start der Konfiguration ==

1. Ethernet-Verbindung zwischen Computer und Gateway herstellen

2. Ggf. die IP-Adresse der LAN-Schnittstelle auf das Subnetz des Gateways abstimmen

3. Webbrowser öffnen

4. Die IP-Adresse des Gateways (Default: 192.168.1.1:3000) in das Adressfeld des Browsers eingeben und die Eingabe bestätigen. Anschließend erfolgt eine Benutzername/Passwort-Abfrage.

[[Datei:GW4100x Login 2.jpg| 250px | rahmenlos | Login]]

Im Auslieferungszustand lautet der Benutzername „admin“ und das Passwort „admin“.

* Admin: Lese- und Schreibzugriff auf alle Bereiche

Default Passwörter:

* Admin: admin

Nach der Eingabe des Benutzernamens und des Passwortes öffnet sich das Hauptmenü zur Konfiguration des maxx GW410x.

[[Datei:GW4100x MAIN PAGE_2.jpg| 200px | rahmenlos | Hauptseite]]

== Network State ==

In diesem Menüpunkt werden Ihnen aktuelle Status-Informationen zu dem Ethernet-Schnittstellen und den Wireless-Schnittstellen angezeigt.

[[Datei:GW4100X NS ETH_2.jpg| 650px | rahmenlos |Network State]]

{| class="wikitable"
! Network State >> Ethernet Interfaces !!
|-
| Device State || Status der Ethernet-Schnittstelle
'''Unmanaged:''' Nicht konfiguriert

'''Connected:''' Verbunden
|-
| Connection State || Verbindungstatus der Ethernet-Schnittstelle
'''Deactivated:''' Deaktiviert

'''Activated:''' Aktiviert
|-
| IPv4 || IPv4-Adresse mit Subnetzmaske in CIDR-Form
|-
| IPv6 || IPv6-Adresse mit Subnetzmaske in CIDR-Form
|-
| Gateway || IP-Adresse für das Standardgateway
|-
| DNS || IP-Adresse vom Nameserver für die Namensauslösung (DNS)
|}

[[Datei:GW4100X NS WIRELESS_2.jpg| 650px | rahmenlos |Network State]]

{| class="wikitable"
! Network State >> Wireless Interfaces (wwan0) !!
|-
| Device State || Status vom Wireless Interfaces (wwan0)
'''Unmanaged:''' Nicht konfiguriert

'''Disconnected:''' Es besteht keine Verbindung

'''Preparing Connection:''' Die Verbindung wird vorbereitet

'''Checking IP:''' Die IP-Adresse wird überprüft

'''Connected:''' Die Verbindung wurde erfolgreich aufgebaut
|-
| Modem State || Status vom Mobilfunkmodem
'''SIM is missing:''' Es ist keine SIM-Karte verfügbar

'''Locked:''' Das Modem ist gesperrt

'''Initializing:''' Das Modem wird initialisiert

'''Enabled:''' Das Modem ist aktiviert

'''Searching:''' Das Modem sucht eine Verbindung

'''Connecting:''' Das Modem verbindet sich

'''Registered:''' Das Modem ist registriert

'''Connected:''' Das Modem ist verbunden
|-
| Connection State || Allgemeiner Verbindungstatus
'''Deactivated:''' Deaktiviert

'''Activating:''' In der Aktivierung

''' Activated:''' Erfolgreich aktiviert
|-
| Power State || Leistungsmodus der Wireless-Schnittstelle
'''Full-Power Mode:''' Maximale Leistung für den Empfang
|-
| Signal Quality || Empfangsqualität vom aktuell eingebuchten Netz
'''Unknown:''' Unbekannt
|-
| Access Tech || Verbindungsart in das aktuell eingebuchte Netz
'''Unknown:''' Unbekannt

'''GSM:''' 2G (Global System for Mobile Communications)

'''UMTS:''' 3G (Universal Mobile Telecommunications System)

'''LTE:''' 4G (Long Term Evolution)

|-
| IMEI || International Mobile Equipment Identity (15-stellige Seriennummer, anhand derer jedes GSM- oder UMTS-Endgerät weltweit eindeutig identifiziert werden kann)
|-
| Registration State || Registrierungsstatus
'''Idle:''' Bereit für Registrierung

'''Searching:''' Suche nach einem Dienst

'''Home:''' Erfolgreich eingebucht
|-
| Operator ID || Provider-Identifikation vom aktuell eingebuchten Netz
|-
| Operator Name || Provider-Name vom aktuell eingebuchten Netz
|-
| SIM Unlock Retries || SIM-Entsperrungsversuche. Verbleibenden Versuche bis die SIM gesperrt ist und der PUK eingetragen werden muss.
|-
| PUK Unlock Retries || PUK-Entsperrungsversuche. Verbleibenden Versuche für die Eingaben vom PUK.
|-
| SIM Lock State || SIM-Lock-Status
'''Modem is unlocked:''' Modem ist freigeschaltet

'''SIM requires the PIN code:''' Die SIM erfordert den PIN-Code

'''SIM requires the PIN 2 code:''' Die SIM erfordert den PIN 2 Code
|-
| IPv4 || Zugewiesene IPv4-Adresse mit Subnetzmaske in CIDR-Form vom aktuell eingebuchten Netz
|-
| IPv6 || Zugewiesene IPv6-Adresse mit Subnetzmaske in CIDR-Form vom aktuell eingebuchten Netz
|-
| Gateway || Zugewiesene IP-Adresse für das Standardgateway vom aktuell eingebuchten Netz
|-
| DNS || Zugewiesene IP-Adresse vom Nameserver für die Namensauslösung (DNS) vom aktuell eingebuchten Netz
|}

== Local Network ==

Im Menüpunkt "Local Network" können Sie die Netzwerkkonfiguration des Gateways anpassen. Das Gateway ist im Auslieferungszustand als DHCP-Server für die Ethernet-Schnittstelle (eth0) konfiguriert.

[[Datei:GW4100X LOCAL NETWORK_2.jpg| 600px | rahmenlos |Local Network]]

{| class="wikitable"
! Local Network !!
|-
| DHCP Client || Das Gateway kann auch als DHCP Client konfiguriert werden, so dass es automatisch von einem lokalen Router (DHCP Server) eine IP-Adresse, ein entsprechendes Gateway und einen DNS (Namenserver) zugewiesen bekommt. Wenn diese Funktion aktiviert ist, sind weitere Eingaben für die Netzwerkkonfiguration inaktiv. Es wird jedoch die vom lokalen Router (DHCP Server) zugewiesene Konfiguration angezeigt.

'''Achtung''': Stellen Sie sicher, dass Sie im Vorfeld die vom Router (DHCP Server) vergebene IP-Adresse kennen, um weiterhin die Erreichbarkeit des Gateways zu gewährleisten.
|-
| IPv4 || Eingabe der IPv4-Adresse mit Subnetzmaske in CIDR-Form
|-
| IPv6 || Eingabe der IPv6-Adresse mit Subnetzmaske in CIDR-Form
|-
| Gateway || Eingabe der IP-Adresse für das Standardgateway
|-
| Nameserver || Eingabe der IP-Adresse vom Nameserver für die Namensauslösung (DNS)
|-
| DHCP Server || Das Gateway kann auch als DHCP Server konfiguriert werden. Dabei wird den Geräten, die über die Ethernet-Schnittstelle (eth0) verbunden (und als DHCP Client konfiguriert) sind automatisch eine IP-Adresse, ein entsprechendes Gateway und ein Nameserver (DNS) zugewiesen.
'''Offset:''' Offset des Adresspools vom Beginn des Teilnetzes.

'''Size:''' Größe vom Adresspool. Konfigurieren Sie 0 für alle Adressen im Subnetz.

'''Lease Time:''' Vergabezeit in Stunden. Konfigurieren Sie 0 für unendlich.
|-
| Internet access for connected devices allowed || Das Gateway bietet die Möglichkeit für die an der LAN-Schnittstelle angeschlossenen Geräte einen Internetzugang über das Mobilfunkmodem bereitzustellen.

'''Achtung:''' Stellen Sie sicher, dass sich die am Gateway angeschlossenen Geräte im selben Subnetz vom Gateway befinden und das ggf. für das Standardgateway an den Geräten die IP-Adresse vom Gateway konfiguriert ist.
|}
Über die USB-Schnittstelle am maxx GW410x kann über einen USB_TO_ETHERNET Adapter eine zweite Ethernet-Schnittstelle (eth1) realisiert werden. Nachdem der USB_TO_ETHERNET Adapter gesteckt ist, erscheint automatisch ein zusätzliches Konfigurationsfeld für eth1. Vom Gateway werden Adapter mit dem Chipsatz '''Asix IC AX88772B''' unterstützt.

Des Weiteren kann über die USB-Schnittstelle am maxx GW410x ein USB_TO_WLAN Adapter angeschlossen werden. Dadurch ist es möglich, dass max GW410x als WLAN Client oder als WLAN Access Point zu konfigurieren.
Vom Gateway werden Adapter mit dem Chipsatz '''Atheros AR9271L''' unterstützt.
Weitere Informationen für die Verwendung vom USB_TO_WLAN Adapter erhalten Sie gerne von unserem Team für das technische Consulting.

== Wireless Network ==

Im Menüpunkt "Wireless Network” legen Sie die Einstellungen für die Nutzung des Mobilfunknetzwerkes vom maxx GW410x fest.

[[Datei:GW4100X WIRELESS NETWORK SETTINGS 3.jpg| 600px | rahmenlos | Wireless Network]]

{| class="wikitable"
! Wireless Network !!
|-
| APN || Name des Anschlusspunktes im Paketdaten-Netzwerk (Providervorgabe)
|-
| PIN || Eingaben vom PIN für die SIM-Karte
|-
| Authentication Type || Wählen Sie die Protokolle für die Anmeldung beim Provider:
'''None:''' Der APN des Providers erfordert keine Anmeldung (Voreinstellung)

'''PAP only:''' Nur Password Authentication Protocol

'''CHAP only:''' Nur Challenge-Handshake Authentication Protocol

'''PAP/CHAP:''' Password oder Challenge-Handshake Authentication Protocol
|-
| Roaming allowed || '''Enabled:''' Es besteht die Möglichkeit, dass das Gateway sich über ein fremdes Netz einwählen kann. Hierbei können je nach Vertrag zusätzliche Kosten entstehen.
'''Disabled:''' Deaktivierung vom Roaming. Es wird automatisch das Heimatnetz des Providers genutzt. Sollte dies nicht möglich sein, kommt keine Verbindung zustande.
|}

== Applications ==

Die programmierbaren IIoT-Mobilfunk-Gateways von IoTmaxx besitzen eine Vielzahl vorinstallierter Applikationen für die unterschiedlichsten Anwendungsfälle.

Bitte vergleichen Sie hier: [[Applications]]

== Passwords ==
Im Menüpunkt "Passwords" können Sie das Passwort für die Webconfig und den SSH-Zugang anpassen.

''' Achtung:''' Bitte gehen Sie bei der Änderung von Passwörtern mit großer Sorgfalt vor. Eine fehlerhafte Eingabe des Passwortes kann dazu führen das das Gateway weder über die Webconfig als auch über SSH erreichbar ist.'''

[[Datei:GW4100X PASSWORDS.jpg| 600px | rahmenlos |Passwords]]

'''Webconfig'''

Im Auslieferungszustand lautet der Benutzername „admin“ und das Passwort „admin“.

Es gelten die folgenden Rechte für die Benutzerrollen:

Admin: Lese- und Schreibzugriff auf alle Bereiche

'''SSH'''

Im Auslieferungszustand lautet der Benutzername „root“ und das Passwort „iotmaxx“.

Es gelten die folgenden Rechte für die Benutzerrollen:

root: Lese- und Schreibzugriff auf alle Bereiche

{| class="wikitable"
! Passwords !!
|-
| Username || Aktueller Benutzername für den das Passwort geändert werden soll
|-
| Current password || Eingabe des aktuell verwendeten Passwortes
|-
| New password 1 || Eingabe des neu zu verwendenden Passwortes. Das Passwort muss mindestes 4 Zeichen besitzen.
|-
| New password 2 || Wiederholte Eingabe des neu zu verwendenden Passwortes. Das Passwort muss mindestes 4 Zeichen besitzen.
|-
|}
<languages/>

=Technische Details=

Das programmierbare Mobilfunk-Gateway maxx GW4100 für industrielle Anwendungen sammelt und verarbeitet die Informationen Ihrer Geräte, Maschinen und Sensoren und überträgt sie über das erweiterte LTE-Netz.

==Linux login==

Die Anmeldung am Linux-System ist standardmäßig über eine ssh-Verbindung auf eth0 oder über die interne (nicht nach außen geführte) serielle Konsole an der RS232-Schnittstelle (115.200 Baud, 8N1) möglich.

'''login:''' root

'''password:''' iotmaxx

Bitte ändern Sie zumindest das Passwort und deaktivieren Sie die serielle Konsole, bevor Sie das Gerät in Betrieb nehmen. Die Verwendung von weiteren Sicherheitsmaßnahmen (PSK etc.) wird zusätzlich empfohlen.

=Schnittstellen=
Im folgenden Abschnitt werden die verschiedenen Schnittstellen des GW4100 im Detail beschrieben. Diese Grafik zeigt die Verteilung der Schnittstellen:

[[Datei:Front_GW4100.jpg| 400px |rahmenlos|Beschreibung]]

==Pinout RS232, RS485, CAN-Bus, 1-Wire connector==

"'''Label'''" beschreibt die Beschriftung auf der Frontplatte

"'''Signal'''" beschreibt den Verweis auf die Linux-Zuordnung

{| class="wikitable" width="40%"
! Description !! Function !! Label !! Signal !! Pin !! Pin !! Signal !! Label !! Function
|-
| [[ #1-wire ]]
| 1-Wire
| 1w
| style="text-align:right" | Data
| style="background:#b3bac5; text-align:center" | 1
| style="background:#b3bac5; text-align:center"| 2
| +5V
| 5V
| Power 1-Wire
|-
| [[ #CAN ]]
| CAN high
| CH
| style="text-align:right" | High
| style="background:#b3bac5; text-align:center"| 3
| style="background:#b3bac5; text-align:center"| 4
| Low
| CL
| CAN Low
|-
|
| GND
| GND
| style="text-align:right" | GND
| style="background:#b3bac5; text-align:center"| 5
| style="background:#b3bac5; text-align:center"| 6
| GND
| GND
| GND
|-
| [[ #RS485 ]]
| RS485
| D-
| style="text-align:right"| D-
| style="background:#b3bac5; text-align:center"| 7
| style="background:#b3bac5; text-align:center"| 8
| D+
| D+
| RS485
|-
| rowspan="2" | [[ #RS232 ]]
| rowspan="2" | RS232
| TXD
| style="text-align:right"| TXD
| style="background:#b3bac5; text-align:center"| 9
| style="background:#b3bac5; text-align:center"| 10
| CTS
| CTS
| rowspan="2" | RS232
|-
| RXD
| style="text-align:right"| RXD
| style="background:#b3bac5; text-align:center"| 11
| style="background:#b3bac5; text-align:center"| 12
| RTS
| RTS
|}

==Pinout Digital IN/OUT connector==

"'''Label'''" beschreibt die Beschriftung auf der Frontplatte

"'''Signal'''" beschreibt den Verweis auf die Linux-Zuordnung

{| class="wikitable" width="40%"
! Description !! Function !! Label !! Signal !! Pin !! Pin !! Signal !! Label !! Function
|-
| [[ #Multi-purpose I/O ]]
| Multi-purpose I/O 1
| G1
| style="text-align:right" | GPIO1
| style="background:#b3bac5; text-align:center" | 1
| style="background:#b3bac5; text-align:center"| 2
| GPIO2
| G2
| Multi-purpose I/O 2
|-
|
| GND
| GND
| style="text-align:right" | GND
| style="background:#b3bac5; text-align:center"| 3
| style="background:#b3bac5; text-align:center"| 4
| GND
| GND
| GND
|-
| rowspan="2" | [[ #Digital inputs ]]
| Digital Input 1
| l1
| style="text-align:right" | GPI1
| style="background:#b3bac5; text-align:center"| 5
| style="background:#b3bac5; text-align:center"| 6
| GPI2
| l2
| Digital Input 2
|-
| Digital Input 3
| l3
| style="text-align:right"| GPI3
| style="background:#b3bac5; text-align:center"| 7
| style="background:#b3bac5; text-align:center"| 8
| GPI4
| I4
| Digital Input 4
|}

==Power supply==

Das Gerät benötigt ein externes ES1/PS2 DC-Netzteil 8-30V, 25W.

==Ethernet==

10/100MBit Ethernet-Schnittstelle, standardmäßig als DHCP-Server mit der IP-Adresse 192.168.1.1 konfiguriert.

==USB==

USB 2.0 Host-Schnittstelle zum Anschluss von externen USB-Geräten. Bitte beachten Sie, dass für viele Geräte ein entsprechender Linux-Treiber erforderlich ist.

==SD card==

Micro SD-Kartenschnittstelle zum Hinzufügen von zusätzlichem nichtflüchtigem Speicher zum System. Bitte verwenden Sie eine SD-Karte, um sich schnell ändernde Daten (z. B. Datenbanken usw.) zu speichern, da der interne Flash-Speicher nur eine begrenzte Anzahl von Schreibzyklen zulässt, bevor es zu einer Beschädigung des Speichers kommen kann.

==CAN==

Die Schnittstelle gemäß der CAN 2.0B-Protokollspezifikation wird über die Flexcan-Schnittstelle des i.MX7D und einen NXP TJA1051-Transceiver realisiert. Sie verfügt über einen schaltbaren 120R-Abschlusswiderstand.

Auf der Linux-Seite wird eine SocketCAN-Schnittstelle (can0) mit einer Standard-Bitrate von 250.000 bit/s bereitgestellt.

Der Abschlusswiderstand wird aktiviert, indem CAN_TERM_EN_n auf Low gesetzt wird. Siehe Linux-Zuordnung für Details.

==RS485==

Eine nicht-isolierte RS485-Schnittstelle ist als /dev/ttymxc3 verfügbar. Die Schnittstelle enthält keinen Abschlusswiderstand.

==RS232==

Eine 4-Draht-RS232-Schnittstelle ist als /dev/ttymxc2 verfügbar.

==1-wire==

Der GW4100 enthält einen DS2482 I2C zu 1-Wire Brückenbaustein von Maxim Integrated (https://www.maximintegrated.com/en/products/interface/controllers-expanders/DS2482-100.html#). Der entsprechende Treiber ist in den Linux-Mainline-Kernel integriert und alle 1-Wire-Funktionen sind dem sysfs-Dateisystem ausgesetzt.

Vergleiche https://www.kernel.org/doc/html/latest/w1/w1-generic.html für eine detaillierte Beschreibung.

==Digital inputs==

Die folgende Abbildung zeigt den internen Aufbau der vier digitalen Eingänge:

[[Datei:GPINx.png ]]

Dieses Design ermöglicht den Anschluss von Push-Pull- und Open-Collector-Ausgängen mit einer Schwelle von etwa 4,5 V. Es ist auch möglich, einen mechanischen Schalter oder ein Relais zu verwenden, um den Eingang mit GND zu verbinden, ohne dass ein zusätzlicher Pullup-Widerstand erforderlich ist.

Das folgende Diagramm zeigt einen vereinfachten Aufbau:

[[Datei:GPINxSim.png ]]

Bitte beachten Sie, dass der Eingang intern invertiert ist, d.h. wenn der Eingang entweder unbeschaltet oder mit einer Spannung oberhalb des Schwellenwerts verbunden ist, wird er als logische 0 (niedriger Pegel) gelesen, wenn er mit einer Spannung unterhalb des Schwellenwerts (z.B. 0 V) verbunden ist, wird er als logische 1 (hoher Pegel) gelesen.

Die GPIs sind dem sysfs-Dateisystem auf der Linux-Seite ausgesetzt und können zur Bequemlichkeit des Benutzers automatisch wieder invertiert werden.

TODO: add linux example

==Multi-purpose I/O==

Der Baustein enthält zwei Mehrzweck-GPIOs, die als Ein- oder Ausgang konfiguriert werden können. Bei Bedarf kann ein interner Pullup-Widerstand aktiviert werden.

Außerdem kann der GPIO als Analogeingang verwendet werden, da die Eingangsspannung auch mit einem der internen 12-Bit-ADC-Kanäle (s. On-Board-ADCs) verbunden ist.

[[Datei:MultiPurposeGPIO.png ]]

Der GPIO ist im High- und Lowside-Strompfad strombegrenzt (tbd mA), so dass das gleichzeitige Schließen von High- und Lowside-Schaltern das Gerät nicht beschädigt (ebenso wenig wie ein externer Kurzschluss), dennoch wird davon abgeraten, dies zu tun und stattdessen eine Break-before-Make-Logik zu verwenden.

TODO: add linux example

==GSM==

LTE-Konnektivität mit Fallback zu 3G und 2G wird durch ein integriertes Quectel EC21-Modul bereitgestellt. Auf der Linux-Seite wird das Gerät von ModemManager gesteuert (siehe https://core.docs.ubuntu.com/en/stacks/network/modem-manager/docs/).

Der ModemManager verwendet /dev/ttyUSB3 für die Kommunikation mit dem EC21, /dev/ttyUSB2 ist für die Ausführung von AT-Befehlen aus dem Userspace verfügbar.

Der Status des GSM-Moduls kann zusätzlich mit Hilfe von GSM_PWR_IND_n überwacht werden, das low getrieben wird, wenn das Modul eingeschaltet ist.

Das GW4100 enthält zwei SIM-Kartenhalter, die die Verwendung von 2FF (Mini-SIM) oder 3FF (Micro-SIM) Karten ermöglichen. Es ist möglich, beide Karten zu bestücken, um z. B. die Nutzung verschiedener Netze zu ermöglichen. Die aktive SIM-Karte wird durch das folgende Verfahren ausgewählt.

===SIM Auswahlverfahren===

Zunächst muss die EC21 über AT-Befehle so konfiguriert werden, dass ein SIM-Hot-Swapping möglich ist:

((ABB))

Bitte beachten Sie, dass ein Neustart des Moduls mit AT+CFUN erforderlich ist, die Einstellung bleibt dann erhalten.

Als nächstes muss die SIM "logisch entfernt" werden, indem SIM_EN auf low gesetzt wird.

Danach kann die aktive SIM mit SIM_SEL ausgewählt werden (default high -> 2FF SIM)

TODO: check if accessible old/new interface

===Aktivieren der Datenverbindung===

Das Modem kann dann wie folgt verwendet werden:
<pre>
root@Gateway:~ mmcli -m 0
--------------------------------
General | dbus path: /org/freedesktop/ModemManager1/Modem/0
| device id: dd1983f3c13bd25a19647d2fca076dad57ef5c57
--------------------------------
Hardware | manufacturer: Quectel
| model: EC21
| firmware revision: EC21EFAR06A02M4G
| supported: gsm-umts, lte
| current: gsm-umts, lte
| equipment id: 867962042149685
--------------------------------
System | device: /sys/devices/platform/soc/30800000.bus/30b30000.usb/ci_hdrc.1/usb1/1-1/1-1.1
| drivers: option1
| plugin: Quectel
| primary port: ttyUSB2
| ports: ttyUSB0 (qcdm), ttyUSB2 (at), ttyUSB3 (at)
--------------------------------
Numbers | own: +4915140075573
--------------------------------
Status | unlock retries: sim-pin (3), sim-puk (10), sim-pin2 (3), sim-puk2 (10)
| state: disabled
| power state: on
| signal quality: 0% (cached)
--------------------------------
Modes | supported: allowed: 2g, 3g, 4g; preferred: none
| current: allowed: 2g, 3g, 4g; preferred: none
--------------------------------
IP | supported: ipv4, ipv6, ipv4v6
--------------------------------
3GPP | imei: 867962042149685
--------------------------------
3GPP EPS | ue mode of operation: csps-2
--------------------------------
SIM | dbus path: /org/freedesktop/ModemManager1/SIM/0
</pre>

Nach jedem Reset erhöht das Modem seine Nummer.

So fügen Sie eine neue Verbindung hinzu:

<pre>
root@Gateway:~ nmcli c add type gsm ifname "*" con-name telekom apn "internet.t-mobile"
Connection 'telekom' (17bdada4-4361-4eca-8506-f6eab6b26a48) successfully added.
</pre>

Und dann, um die Verbindung zu aktivieren:

<pre>

root@Gateway:~ nmcli c up telekom
Connection successfully activated (D-Bus active path: /org/freedesktop/NetworkManager/ActiveConnection/3)

root@Gateway:~ mmcli -m 0
--------------------------------
General | dbus path: /org/freedesktop/ModemManager1/Modem/0
| device id: 794eb538900f787165b66d8af66496a4e7cd0c8b
--------------------------------
Hardware | manufacturer: QUALCOMM INCORPORATED
| model: QUECTEL Mobile Broadband Module
| firmware revision: EC21EFAR06A02M4G
| carrier config: default
| h/w revision: 10000
| supported: gsm-umts, lte
| current: gsm-umts, lte
| equipment id: 867962042149685
--------------------------------
System | device: /sys/devices/platform/soc/30800000.bus/30b30000.usb/ci_hdrc.1/usb1/1-1/1-1.1
| drivers: qmi_wwan, option1
| plugin: Quectel
| primary port: cdc-wdm0
| ports: cdc-wdm0 (qmi), ttyUSB0 (qcdm), ttyUSB2 (at), wwan0 (net),
| ttyUSB3 (at)
--------------------------------
Numbers | own: 4915140075573
--------------------------------
Status | lock: sim-pin2
| unlock retries: sim-pin (3), sim-puk (10), sim-pin2 (3), sim-puk2 (10)
| state: connected
| power state: on
| access tech: gsm
| signal quality: 41% (recent)
--------------------------------
Modes | supported: allowed: 2g; preferred: none
| allowed: 3g; preferred: none
| allowed: 4g; preferred: none
| allowed: 2g, 3g; preferred: 3g
| allowed: 2g, 3g; preferred: 2g
| allowed: 2g, 4g; preferred: 4g
| allowed: 2g, 4g; preferred: 2g
| allowed: 3g, 4g; preferred: 3g
| allowed: 3g, 4g; preferred: 4g
| allowed: 2g, 3g, 4g; preferred: 4g
| allowed: 2g, 3g, 4g; preferred: 3g
| allowed: 2g, 3g, 4g; preferred: 2g
| current: allowed: 2g, 3g, 4g; preferred: 4g
--------------------------------
Bands | supported: egsm, dcs, utran-1, utran-5, utran-8, eutran-1, eutran-3,
| eutran-5, eutran-7, eutran-8, eutran-20
| current: egsm, dcs, utran-1, utran-5, utran-8, eutran-1, eutran-3,
| eutran-5, eutran-7, eutran-8, eutran-20
--------------------------------
IP | supported: ipv4, ipv6, ipv4v6
--------------------------------
3GPP | imei: 867962042149685
| operator id: 26201
| registration: home
--------------------------------
3GPP EPS | ue mode of operation: csps-2
--------------------------------
SIM | dbus path: /org/freedesktop/ModemManager1/SIM/0
--------------------------------
Bearer | dbus path: /org/freedesktop/ModemManager1/Bearer/0
</pre>

==GNSS==

Für die Geopositionierung steht ein im Quectel EC21 Modul integrierter GNSS-Empfänger zur Verfügung. Die NMEA-Daten werden auf /dev/ttyUSB1 ausgegeben. Der GNSS-Empfänger wird mit dem folgenden AT-Befehl aktiviert:

AT+QGPS=1

Eine detaillierte Beschreibung der verfügbaren Konfigurationsoptionen finden Sie in der EC21-Dokumentation (https://www.quectel.com/product/ec21.htm).

Die aktive Antennenversorgung wird durch den Regler 9 des Qorvo ACT8847 Power Management ic (PMIC) bereitgestellt. Folgende Befehle aus dem Anwenderbereich sind erforderlich, um die Versorgung zu aktivieren:

<pre>
# regulator 3.0V
i2cset -y 2 0x5a 0x70 0x36 i
# regulator on
i2cset -y 2 0x5a 0x71 0x80 i
</pre>

==User LEDs==

Das Gerät enthält zwei vom Benutzer steuerbare LEDs (z. B. zur Statusanzeige). Diese sind im sysfs unter /sys/class/leds/ zu finden. Siehe Linux-Zuordnung für Details.

Bitte vergleiche https://www.kernel.org/doc/Documentation/leds/leds-class.txt für weitere Details.

==User Button==

Für benutzerdefinierte Funktionen (z.B. Rücksetzen auf Werkseinstellungen) steht eine versiegelte Taste zur Verfügung.

TODO: add linux example, picture

==On board ADCs==

Das folgende Diagramm zeigt die Verwendung der acht 12-Bit-ADCs des i.MX7D-Prozessors.

[[Datei:ADC_internal.png ]]

ADC 0 ermöglicht den Zugriff auf die Spannungspegel der beiden Mehrzweck-GPIOs und die Versorgungsspannung sowie eine Temperaturanzeige der Karte, während ADC 1 zur Überwachung des Systemzustands verwendet wird.

Alle ADC-Werte sind vom Linux-Benutzerbereich aus über die sysfs-Zuordnung (/sys/bus/iio/devices/) zugänglich.

Beispiel 1: Ablesen des Istwerts der 5-V-Versorgungsspur

<pre>
root@Gateway:~ cat /sys/bus/iio/devices/iio:device1/in_voltage0_raw
3789
</pre>

Berechnung der Spannung:

[[Datei:on board 3.png ]]

Beispiel 2: Ablesen der Versorgungsspannung des Systems

<pre>
root@Gateway:~ cat /sys/bus/iio/devices/iio:device0/in_voltage2_raw
2145
</pre>

Berechnung der Spannung:

[[Datei:on board 5.png ]]

Bitte beachten Sie, dass die Messung hinter der Eingangsdiode erfolgt und daher die tatsächliche Versorgungsspannung um ca. 0,5V höher ist (in diesem Fall beträgt die tatsächliche Versorgungsspannung 24V).

Beispiel 3: Ablesen der Platinentemperatur

<pre>
root@Gateway:~ cat /sys/bus/iio/devices/iio:device0/in_voltage3_raw
2576
</pre>

Berechnung des NTC-Widerstands:

[[Datei:on board 7.png ]]

[[Datei:on board 8.png ]]

[[Datei:on board 9.png ]]

Wenn man die Widerstandsnachschlagetabelle im Datenblatt der Widerstände (NCP15XV103J03RC) zu Rate zieht, liegt die Temperatur auf der Platine bei etwa 37°C.

=Linux mapping=
==Digital and analog I/Os (deprecated sysfs mapping)==

{| class="wikitable" width="40%"
! Signal !! Linux mapping !! Typ
|-
| GPIN1
| style="text-align:right" | /sys/class/gpio10
| rowspan="4" | digital inputs
|-
| GPIN2
| style="text-align:right" | /sys/class/gpio11
|-
| GPIN3
| style="text-align:right" | /sys/class/gpio14
|-
| GPIN4
| style="text-align:right" | /sys/class/gpio15
|-
| GPIO0_IN_n
| style="text-align:right" | /sys/class/gpio3
| rowspan="10" | Multi-purpose I/Os
|-
| GPIO0_ADC
| style="text-align:right" | /sys/bus/iio/devices/iio:device0/in_voltage0_raw
|-
| GPIO0_HIGHSIDE
| style="text-align:right" | /sys/class/gpio0
|-
| GPIO0_LOWSIDE
| style="text-align:right" | /sys/class/gpio1
|-
| GPIO0_PULLUP
| style="text-align:right" | /sys/class/gpio2
|-
| GPIO1_IN_n
| style="text-align:right" | /sys/class/gpio9
|-
| GPIO1_ADC
| style="text-align:right" | /sys/bus/iio/devices/iio:device0/in_voltage0_raw
|-
| GPIO1_HIGHSIDE
| style="text-align:right" | /sys/class/gpio4
|-
| GPIO1_LOWSIDE
| style="text-align:right" | /sys/class/gpio5
|-
| GPIO1_PULLUP
| style="text-align:right" | /sys/class/gpio8
|-
| LED_USR1
| style="text-align:right" | /sys/class/leds/iotmaxx:green:usr1/
| LED B
|-
| LED_USR2
| style="text-align:right" | /sys/class/leds/iotmaxx:green:usr2/
| LED A
|-
| PBSTAT_IRQ_n
| style="text-align:right" | /sys/class/gpio33
| PMIC PBSTAT IRQ
|-
| 5V_PERIPH_EN
| style="text-align:right" | /sys/class/gpio34
| N/A, always on
|-
| ACT8847_IRQ_n
| style="text-align:right" | /sys/class/gpio90
| PMIC IRQ
|-
| RTC_INTA_n
| style="text-align:right" | /sys/class/gpio61
| RTC IRQ
|-
| USR_SWITCH_n
| style="text-align:right" | /sys/class/gpio91
| User switch
|-
| SIM_ENABLE
| style="text-align:right" | /sys/class/gpio89
| rowspan="2" | SIM select
|-
| SIM_SEL
| style="text-align:right" | /sys/class/gpio112
|-
| CAN_TERM_EN_n
| style="text-align:right" | /sys/class/gpio108
| CAN termination resistor
|-
| GSM_PWR_IND_n
| style="text-align:right" | /sys/class/gpio115
| GSM power indicator
|}

==Digital and analog I/Os (new libgpiod mapping)==

{| class="wikitable" width="40%"
! Signal !! Linux mapping !! line !! Typ
|-
| GPIN1
| style="text-align:right" | gpiochip0
| line 10
| rowspan="4" | digital inputs
|-
| GPIN2
| style="text-align:right" | gpiochip0
| line 11
|-
| GPIN3
| style="text-align:right" | gpiochip0
| line 14
|-
| GPIN4
| style="text-align:right" | gpiochip0
| line 15
|-
| GPIO0_IN_n
| style="text-align:right" | gpiochip0
| line 13
| rowspan="10" | Multi-purpose I/Os
|-
| GPIO0_ADC
| style="text-align:right" | /sys/bus/iio/devices/iio:device0/in_voltage0_raw
|
|-
| GPIO0_HIGHSIDE
| style="text-align:right" | gpiochip0
| line 0
|-
| GPIO0_LOWSIDE
| style="text-align:right" | gpiochip0
| line 1
|-
| GPIO0_PULLUP
| style="text-align:right" | gpiochip0
| line 2
|-
| GPIO1_IN_n
| style="text-align:right" | gpiochip0
| line 9
|-
| GPIO1_ADC
| style="text-align:right" | /sys/bus/iio/devices/iio:device0/in_voltage1_raw
|
|-
| GPIO1_HIGHSIDE
| style="text-align:right" | gpiochip0
| line 4
|-
| GPIO1_LOWSIDE
| style="text-align:right" | gpiochip0
| line 5
|-
| GPIO1_PULLUP
| style="text-align:right" | gpiochip0
| line 8
|-
| LED_USR1
| style="text-align:right" | /sys/class/leds/iotmaxx:green:usr1/
|
| LED B
|-
| LED_USR2
| style="text-align:right" | /sys/class/leds/iotmaxx:green:usr2/
|
| LED A
|-
| PBSTAT_IRQ_n
| style="text-align:right" | gpiochip1
| line 1
| PMIC PBSTAT IRQ
|-
| 5V_PERIPH_EN
| style="text-align:right" | gpiochip1
| line 2
| N/A, always on
|-
| ACT8847_IRQ_n
| style="text-align:right" | gpiochip2
| line 26
| PMIC IRQ
|-
| RCT_INTA_n
| style="text-align:right" | gpiochip1
| line 29
| RTC IRQ
|-
| USR_SWITCH_n
| style="text-align:right" | gpiochip2
| line 27
| USER switch
|-
| SIM_ENABLE
| style="text-align:right" | gpiochip2
| line 25
| rowspan="2" | SIM select
|-
| SIM_SEL
| style="text-align:right" | gpiochip3
| line 16
|-
| CAN_TERM_EN_n
| style="text-align:right" | gpiochip3
| line 12
| CAN termination resistor
|-
| GSM_PWR_IND_n
| style="text-align:right" | gpiochip3
| line 19
| GSM power indicator
|}

==GPIO Linux User-Space Beispiele (veraltetes sysfs-Mapping)==

Beispiel: Exportieren und Lesen von GPIN1 (High-Pegel am Eingangs-Pin)

<pre>
root@Gateway:~ echo 11 > /sys/class/gpio/export
root@Gateway:~ echo 1 > /sys/class/gpio/gpio11/active_low
root@Gateway:~ cat /sys/class/gpio/gpio11/value
1
</pre>

Beispiel: Exportieren und Aktivieren von GPIO1 Pullup

<pre>
root@Gateway:~ echo 8 > /sys/class/gpio/export
root@Gateway:~ echo high > /sys/class/gpio/gpio8/direction
</pre>

Vergleiche https://www.kernel.org/doc/html/latest/admin-guide/gpio/sysfs.html für eine detaillierte Beschreibung der sysfs-Gpio-Schnittstelle.

==GPIO Linux User-Space Beispiele (neue libgpiod-Zuordnung)==

Beispiel: Lesen von GPIN1 (High-Pegel am Eingangs-Pin), kein Export erforderlich

<pre>
root@Gateway:~ gpioget --active-low gpiochip0 11
1
</pre>

Beispiel: GPIO1 Pullup aktivieren, kein Export erforderlich

<pre>
gpioset gpiochip0 8=1
</pre>

Vergleiche https://git.kernel.org/pub/scm/libs/libgpiod/libgpiod.git/tree/README für eine Beschreibung der libgpiod-Schnittstelle.

==Serielle Schnittstellen und Busse==

{| class="wikitable" width="40%"
! Interface or bus !! Linux mapping !!
|-
| RS232
| style="text-align:right" | /dev/ttymxc2
| rowspan="2" | linux console
|-
| RS485
| style="text-align:right" | /dev/ttymxc3
|-
| 1-wire
| style="text-align:right" | /sys/bus/w1/
| rowspan="3" | see kernel.org
|-
| CAN
| style="text-align:right" | can0 network interface
|-
| Ethernet
| style="text-align:right" | eth network interface
|-
| USB
|
| device dependent
|}

Maxx GW4100

2022-03-22T07:36:32Z

Nbrandt: /* Applikationen */

= Quick Guide =

== Einleitung ==

Die IoTmaxx Gateway-Serie GW410x ermöglicht über ihre zahlreichen Schnittstellen ein Einfaches einsammeln und verarbeiten von Informationen mit einer sicheren Übertragung über das Mobilfunknetz.
Zur Inbetriebnahme ist eine SIM-Karte Ihres Mobilfunkbetreibers mit geeignetem Tarif erforderlich.

Bitte beachten Sie: Eine falsche PIN kann zur Sperrung der SIM-Karte führen. Halten Sie sicherheitshalber die Super-Pin bzw. PUK zur Freischaltung bereit.

'''Bitte legen Sie die SIM-Karte zunächst NICHT in das Gateway ein!'''

== Zur Inbetriebnahme des Gateways benötigen Sie: ==

* Eine LTE-Antenne mit SMA-Stecker
* Ein Netzteil mit einer Ausgangsspannung im Bereich von 10 bis 30V DC/>15W
* Ein Ethernet-Kabel
* Einen PC oder Laptop mit Ethernet-Anschluss und installiertem Browser
* Eine SIM-Karte im Formfaktor MINI-SIM (2ff)

== Montage der Antenne ==

Schrauben Sie die Antenne an den „GSM“-Anschluss des Gateways. Wenn Sie eine Antenne mit GPS-Signal benutzen, schließen Sie bitte den zweiten SMA-Stecker an den „GPS“-Anschluss an.

== Einlegen der SIM-Karte ==

Auf der Rückseite des Gateways befinden sich zwei Slots für SIM-Karten sowie ein Slot für eine Micro SD-Karte.
Der obige Slot ist für eine MINI-Sim (2ff), der darunter liegenden Slot für eine MICRO-SIM (3ff) vorbereitet.

'''Im Auslieferungszustand wird nur der Slot für eine MINI-Sim (2ff) unterstützt.'''

Stecken Sie bitte, wie in der Abbildung dargestellt, die SIM-Karte in den obersten Slot, bis diese einrastet.
Verwenden Sie gegebenenfalls ein flaches Werkzeug (z.B. Schraubenzieher) um die SIM einzuschieben.

[[Datei:GW4100x SIM SLOT.jpg| 150px |rahmenlos | SIM-Karten Slot]]

== Anschluss der Spannungsversorgung ==

Schließen Sie bitte das Netzteil an den Steckverbinder mit der „+ -“ Beschriftung an. Achten Sie auf die richtige Polarität. Das Gateway ist mit einem Verpolungsschutz ausgerüstet, bleibt aber bei falscher Polarität inaktiv.
Nach dem Einschalten des Netzteils leuchten während der Initialisierungsphase (ca. 5s) die LED A und LED B, die Power-LED leuchtet dauerhaft. Wenn die LED A und LED B erloschen sind, ist das Gerät betriebsbereit.

== Konfiguration des GW410x ==

Die Konfiguration des Gateways erfolgt über das integrierte Webinterface. Bitte gehen Sie wie folgt vor:

a. Verbinden Sie Ihren PC mit dem Ethernet-Kabel direkt mit der Ethernet-Schnittstelle (eth0). Das Gateway ist im Auslieferungszustand als DHCP Server konfiguriert, sodass Ihr PC automatisch eine IP-Adresse erhält.

b. Öffnen Sie einen Browser auf Ihrem PC und geben Sie die IP-Adresse 192.168.1.1:3000 in das Adressfeld ein.

c. Geben Sie im Anmeldefenster als Nutzername und Passwort jeweils „admin“ (ohne Anführungszeichen) ein und klicken Sie auf „LOGIN“.

d. Öffnen Sie den Menüpunkt „Wireless Network“. Tragen Sie hier unter „PIN“ die PIN-Nummer Ihrer SIM-Karte ein, sofern Sie die PIN-Abfrage Ihrer SIM-Karte nicht abgeschaltet haben. In diesem Fall kann das Feld leer bleiben.

e. Des Weiteren tragen Sie gegebenenfalls den APN und wenn gefordert den Usernamen und Passwort für die Authentifizierung der Datenübertragung in Ihrem Mobilfunknetz ein. Die Daten erhalten Sie von Ihrem Mobilfunkanbieter.

f. Bestätigen Sie Ihre Eingaben mit „SUBMIT“.

[[Datei:GW4100X WIRELESS NETWORK_3.jpg| 600px | rahmenlos | Wireless Network]]

g. Trennen Sie nun das Gateway vom Netzteil und legen jetzt die SIM-Karte wie beschrieben ein.

h. Verbinden Sie das Gateway wieder mit der Spannungsversorgung und prüfen Sie die erfolgreiche Einwahl und Verbindung zum Mobilfunknetz unter dem Menüpunkt „Network State“.

== Zustandssignalisierung ==

Der Betriebszustand der Mobilfunkverbindung der Gateway-Serie GW410x wird über die GSM Status LED wie im Folgenden beschrieben signalisiert.

{| class="wikitable"
! GSM Status LED !! Netzverbindung
|-
| Langsames Blinken (kurz EIN / lang AUS) || Netzsuche
|-
| Langsames Blinken (lang EIN / kurz AUS)|| Eingebucht, aber keine Datenverbindung
|-
| Schnelles Blinken (kurz EIN / kurz AUS) || Eingebucht und eine bestehende Datenverbindung
|}

= Konfiguration über WBM (Web Based Management) =

Die Konfiguration des maxx GW410x erfolgt über eine Webbrowser basierende Funktion. Hierfür müssen zunächst folgende Bedingungen erfüllt sein:

* Der PC, der zur Konfiguration des Gateways verwendet wird, verfügt über eine LAN-Schnittstelle.
* Auf dem PC ist ein Webbrowser installiert (z.B. Google Chrome, Mozilla Firefox, Microsoft Internet Explorer).
* Das Gateway ist mit einer Spannungsquelle verbunden.

== Start der Konfiguration ==

1. Ethernet-Verbindung zwischen Computer und Gateway herstellen

2. Ggf. die IP-Adresse der LAN-Schnittstelle auf das Subnetz des Gateways abstimmen

3. Webbrowser öffnen

4. Die IP-Adresse des Gateways (Default: 192.168.1.1:3000) in das Adressfeld des Browsers eingeben und die Eingabe bestätigen. Anschließend erfolgt eine Benutzername/Passwort-Abfrage.

[[Datei:GW4100x Login 2.jpg| 250px | rahmenlos | Login]]

Im Auslieferungszustand lautet der Benutzername „admin“ und das Passwort „admin“.

* Admin: Lese- und Schreibzugriff auf alle Bereiche

Default Passwörter:

* Admin: admin

Nach der Eingabe des Benutzernamens und des Passwortes öffnet sich das Hauptmenü zur Konfiguration des maxx GW410x.

[[Datei:GW4100x MAIN PAGE_2.jpg| 200px | rahmenlos | Hauptseite]]

== Network State ==

In diesem Menüpunkt werden Ihnen aktuelle Status-Informationen zu dem Ethernet-Schnittstellen und den Wireless-Schnittstellen angezeigt.

[[Datei:GW4100X NS ETH_2.jpg| 650px | rahmenlos |Network State]]

{| class="wikitable"
! Network State >> Ethernet Interfaces !!
|-
| Device State || Status der Ethernet-Schnittstelle
'''Unmanaged:''' Nicht konfiguriert

'''Connected:''' Verbunden
|-
| Connection State || Verbindungstatus der Ethernet-Schnittstelle
'''Deactivated:''' Deaktiviert

'''Activated:''' Aktiviert
|-
| IPv4 || IPv4-Adresse mit Subnetzmaske in CIDR-Form
|-
| IPv6 || IPv6-Adresse mit Subnetzmaske in CIDR-Form
|-
| Gateway || IP-Adresse für das Standardgateway
|-
| DNS || IP-Adresse vom Nameserver für die Namensauslösung (DNS)
|}

[[Datei:GW4100X NS WIRELESS_2.jpg| 650px | rahmenlos |Network State]]

{| class="wikitable"
! Network State >> Wireless Interfaces (wwan0) !!
|-
| Device State || Status vom Wireless Interfaces (wwan0)
'''Unmanaged:''' Nicht konfiguriert

'''Disconnected:''' Es besteht keine Verbindung

'''Preparing Connection:''' Die Verbindung wird vorbereitet

'''Checking IP:''' Die IP-Adresse wird überprüft

'''Connected:''' Die Verbindung wurde erfolgreich aufgebaut
|-
| Modem State || Status vom Mobilfunkmodem
'''SIM is missing:''' Es ist keine SIM-Karte verfügbar

'''Locked:''' Das Modem ist gesperrt

'''Initializing:''' Das Modem wird initialisiert

'''Enabled:''' Das Modem ist aktiviert

'''Searching:''' Das Modem sucht eine Verbindung

'''Connecting:''' Das Modem verbindet sich

'''Registered:''' Das Modem ist registriert

'''Connected:''' Das Modem ist verbunden
|-
| Connection State || Allgemeiner Verbindungstatus
'''Deactivated:''' Deaktiviert

'''Activating:''' In der Aktivierung

''' Activated:''' Erfolgreich aktiviert
|-
| Power State || Leistungsmodus der Wireless-Schnittstelle
'''Full-Power Mode:''' Maximale Leistung für den Empfang
|-
| Signal Quality || Empfangsqualität vom aktuell eingebuchten Netz
'''Unknown:''' Unbekannt
|-
| Access Tech || Verbindungsart in das aktuell eingebuchte Netz
'''Unknown:''' Unbekannt

'''GSM:''' 2G (Global System for Mobile Communications)

'''UMTS:''' 3G (Universal Mobile Telecommunications System)

'''LTE:''' 4G (Long Term Evolution)

|-
| IMEI || International Mobile Equipment Identity (15-stellige Seriennummer, anhand derer jedes GSM- oder UMTS-Endgerät weltweit eindeutig identifiziert werden kann)
|-
| Registration State || Registrierungsstatus
'''Idle:''' Bereit für Registrierung

'''Searching:''' Suche nach einem Dienst

'''Home:''' Erfolgreich eingebucht
|-
| Operator ID || Provider-Identifikation vom aktuell eingebuchten Netz
|-
| Operator Name || Provider-Name vom aktuell eingebuchten Netz
|-
| SIM Unlock Retries || SIM-Entsperrungsversuche. Verbleibenden Versuche bis die SIM gesperrt ist und der PUK eingetragen werden muss.
|-
| PUK Unlock Retries || PUK-Entsperrungsversuche. Verbleibenden Versuche für die Eingaben vom PUK.
|-
| SIM Lock State || SIM-Lock-Status
'''Modem is unlocked:''' Modem ist freigeschaltet

'''SIM requires the PIN code:''' Die SIM erfordert den PIN-Code

'''SIM requires the PIN 2 code:''' Die SIM erfordert den PIN 2 Code
|-
| IPv4 || Zugewiesene IPv4-Adresse mit Subnetzmaske in CIDR-Form vom aktuell eingebuchten Netz
|-
| IPv6 || Zugewiesene IPv6-Adresse mit Subnetzmaske in CIDR-Form vom aktuell eingebuchten Netz
|-
| Gateway || Zugewiesene IP-Adresse für das Standardgateway vom aktuell eingebuchten Netz
|-
| DNS || Zugewiesene IP-Adresse vom Nameserver für die Namensauslösung (DNS) vom aktuell eingebuchten Netz
|}

== Local Network ==

Im Menüpunkt "Local Network" können Sie die Netzwerkkonfiguration des Gateways anpassen. Das Gateway ist im Auslieferungszustand als DHCP-Server für die Ethernet-Schnittstelle (eth0) konfiguriert.

[[Datei:GW4100X LOCAL NETWORK_2.jpg| 600px | rahmenlos |Local Network]]

{| class="wikitable"
! Local Network !!
|-
| DHCP Client || Das Gateway kann auch als DHCP Client konfiguriert werden, so dass es automatisch von einem lokalen Router (DHCP Server) eine IP-Adresse, ein entsprechendes Gateway und einen DNS (Namenserver) zugewiesen bekommt. Wenn diese Funktion aktiviert ist, sind weitere Eingaben für die Netzwerkkonfiguration inaktiv. Es wird jedoch die vom lokalen Router (DHCP Server) zugewiesene Konfiguration angezeigt.

'''Achtung''': Stellen Sie sicher, dass Sie im Vorfeld die vom Router (DHCP Server) vergebene IP-Adresse kennen, um weiterhin die Erreichbarkeit des Gateways zu gewährleisten.
|-
| IPv4 || Eingabe der IPv4-Adresse mit Subnetzmaske in CIDR-Form
|-
| IPv6 || Eingabe der IPv6-Adresse mit Subnetzmaske in CIDR-Form
|-
| Gateway || Eingabe der IP-Adresse für das Standardgateway
|-
| Nameserver || Eingabe der IP-Adresse vom Nameserver für die Namensauslösung (DNS)
|-
| DHCP Server || Das Gateway kann auch als DHCP Server konfiguriert werden. Dabei wird den Geräten, die über die Ethernet-Schnittstelle (eth0) verbunden (und als DHCP Client konfiguriert) sind automatisch eine IP-Adresse, ein entsprechendes Gateway und ein Nameserver (DNS) zugewiesen.
'''Offset:''' Offset des Adresspools vom Beginn des Teilnetzes.

'''Size:''' Größe vom Adresspool. Konfigurieren Sie 0 für alle Adressen im Subnetz.

'''Lease Time:''' Vergabezeit in Stunden. Konfigurieren Sie 0 für unendlich.
|-
| Internet access for connected devices allowed || Das Gateway bietet die Möglichkeit für die an der LAN-Schnittstelle angeschlossenen Geräte einen Internetzugang über das Mobilfunkmodem bereitzustellen.

'''Achtung:''' Stellen Sie sicher, dass sich die am Gateway angeschlossenen Geräte im selben Subnetz vom Gateway befinden und das ggf. für das Standardgateway an den Geräten die IP-Adresse vom Gateway konfiguriert ist.
|}
Über die USB-Schnittstelle am maxx GW410x kann über einen USB_TO_ETHERNET Adapter eine zweite Ethernet-Schnittstelle (eth1) realisiert werden. Nachdem der USB_TO_ETHERNET Adapter gesteckt ist, erscheint automatisch ein zusätzliches Konfigurationsfeld für eth1. Vom Gateway werden Adapter mit dem Chipsatz '''Asix IC AX88772B''' unterstützt.

Des Weiteren kann über die USB-Schnittstelle am maxx GW410x ein USB_TO_WLAN Adapter angeschlossen werden. Dadurch ist es möglich, dass max GW410x als WLAN Client oder als WLAN Access Point zu konfigurieren.
Vom Gateway werden Adapter mit dem Chipsatz '''Atheros AR9271L''' unterstützt.
Weitere Informationen für die Verwendung vom USB_TO_WLAN Adapter erhalten Sie gerne von unserem Team für das technische Consulting.

== Wireless Network ==

Im Menüpunkt "Wireless Network” legen Sie die Einstellungen für die Nutzung des Mobilfunknetzwerkes vom maxx GW410x fest.

[[Datei:GW4100X WIRELESS NETWORK SETTINGS 3.jpg| 600px | rahmenlos | Wireless Network]]

{| class="wikitable"
! Wireless Network !!
|-
| APN || Name des Anschlusspunktes im Paketdaten-Netzwerk (Providervorgabe)
|-
| PIN || Eingaben vom PIN für die SIM-Karte
|-
| Authentication Type || Wählen Sie die Protokolle für die Anmeldung beim Provider:
'''None:''' Der APN des Providers erfordert keine Anmeldung (Voreinstellung)

'''PAP only:''' Nur Password Authentication Protocol

'''CHAP only:''' Nur Challenge-Handshake Authentication Protocol

'''PAP/CHAP:''' Password oder Challenge-Handshake Authentication Protocol
|-
| Roaming allowed || '''Enabled:''' Es besteht die Möglichkeit, dass das Gateway sich über ein fremdes Netz einwählen kann. Hierbei können je nach Vertrag zusätzliche Kosten entstehen.
'''Disabled:''' Deaktivierung vom Roaming. Es wird automatisch das Heimatnetz des Providers genutzt. Sollte dies nicht möglich sein, kommt keine Verbindung zustande.
|}

== Applications ==

== Passwords ==
Im Menüpunkt "Passwords" können Sie das Passwort für die Webconfig und den SSH-Zugang anpassen.

''' Achtung:''' Bitte gehen Sie bei der Änderung von Passwörtern mit großer Sorgfalt vor. Eine fehlerhafte Eingabe des Passwortes kann dazu führen das das Gateway weder über die Webconfig als auch über SSH erreichbar ist.'''

[[Datei:GW4100X PASSWORDS.jpg| 600px | rahmenlos |Passwords]]

'''Webconfig'''

Im Auslieferungszustand lautet der Benutzername „admin“ und das Passwort „admin“.

Es gelten die folgenden Rechte für die Benutzerrollen:

Admin: Lese- und Schreibzugriff auf alle Bereiche

'''SSH'''

Im Auslieferungszustand lautet der Benutzername „root“ und das Passwort „iotmaxx“.

Es gelten die folgenden Rechte für die Benutzerrollen:

root: Lese- und Schreibzugriff auf alle Bereiche

{| class="wikitable"
! Passwords !!
|-
| Username || Aktueller Benutzername für den das Passwort geändert werden soll
|-
| Current password || Eingabe des aktuell verwendeten Passwortes
|-
| New password 1 || Eingabe des neu zu verwendenden Passwortes. Das Passwort muss mindestes 4 Zeichen besitzen.
|-
| New password 2 || Wiederholte Eingabe des neu zu verwendenden Passwortes. Das Passwort muss mindestes 4 Zeichen besitzen.
|-
|}
<languages/>

=Technische Details=

Das programmierbare Mobilfunk-Gateway maxx GW4100 für industrielle Anwendungen sammelt und verarbeitet die Informationen Ihrer Geräte, Maschinen und Sensoren und überträgt sie über das erweiterte LTE-Netz.

==Linux login==

Die Anmeldung am Linux-System ist standardmäßig über eine ssh-Verbindung auf eth0 oder über die interne (nicht nach außen geführte) serielle Konsole an der RS232-Schnittstelle (115.200 Baud, 8N1) möglich.

'''login:''' root

'''password:''' iotmaxx

Bitte ändern Sie zumindest das Passwort und deaktivieren Sie die serielle Konsole, bevor Sie das Gerät in Betrieb nehmen. Die Verwendung von weiteren Sicherheitsmaßnahmen (PSK etc.) wird zusätzlich empfohlen.

=Schnittstellen=
Im folgenden Abschnitt werden die verschiedenen Schnittstellen des GW4100 im Detail beschrieben. Diese Grafik zeigt die Verteilung der Schnittstellen:

[[Datei:Front_GW4100.jpg| 400px |rahmenlos|Beschreibung]]

==Pinout RS232, RS485, CAN-Bus, 1-Wire connector==

"'''Label'''" beschreibt die Beschriftung auf der Frontplatte

"'''Signal'''" beschreibt den Verweis auf die Linux-Zuordnung

{| class="wikitable" width="40%"
! Description !! Function !! Label !! Signal !! Pin !! Pin !! Signal !! Label !! Function
|-
| [[ #1-wire ]]
| 1-Wire
| 1w
| style="text-align:right" | Data
| style="background:#b3bac5; text-align:center" | 1
| style="background:#b3bac5; text-align:center"| 2
| +5V
| 5V
| Power 1-Wire
|-
| [[ #CAN ]]
| CAN high
| CH
| style="text-align:right" | High
| style="background:#b3bac5; text-align:center"| 3
| style="background:#b3bac5; text-align:center"| 4
| Low
| CL
| CAN Low
|-
|
| GND
| GND
| style="text-align:right" | GND
| style="background:#b3bac5; text-align:center"| 5
| style="background:#b3bac5; text-align:center"| 6
| GND
| GND
| GND
|-
| [[ #RS485 ]]
| RS485
| D-
| style="text-align:right"| D-
| style="background:#b3bac5; text-align:center"| 7
| style="background:#b3bac5; text-align:center"| 8
| D+
| D+
| RS485
|-
| rowspan="2" | [[ #RS232 ]]
| rowspan="2" | RS232
| TXD
| style="text-align:right"| TXD
| style="background:#b3bac5; text-align:center"| 9
| style="background:#b3bac5; text-align:center"| 10
| CTS
| CTS
| rowspan="2" | RS232
|-
| RXD
| style="text-align:right"| RXD
| style="background:#b3bac5; text-align:center"| 11
| style="background:#b3bac5; text-align:center"| 12
| RTS
| RTS
|}

==Pinout Digital IN/OUT connector==

"'''Label'''" beschreibt die Beschriftung auf der Frontplatte

"'''Signal'''" beschreibt den Verweis auf die Linux-Zuordnung

{| class="wikitable" width="40%"
! Description !! Function !! Label !! Signal !! Pin !! Pin !! Signal !! Label !! Function
|-
| [[ #Multi-purpose I/O ]]
| Multi-purpose I/O 1
| G1
| style="text-align:right" | GPIO1
| style="background:#b3bac5; text-align:center" | 1
| style="background:#b3bac5; text-align:center"| 2
| GPIO2
| G2
| Multi-purpose I/O 2
|-
|
| GND
| GND
| style="text-align:right" | GND
| style="background:#b3bac5; text-align:center"| 3
| style="background:#b3bac5; text-align:center"| 4
| GND
| GND
| GND
|-
| rowspan="2" | [[ #Digital inputs ]]
| Digital Input 1
| l1
| style="text-align:right" | GPI1
| style="background:#b3bac5; text-align:center"| 5
| style="background:#b3bac5; text-align:center"| 6
| GPI2
| l2
| Digital Input 2
|-
| Digital Input 3
| l3
| style="text-align:right"| GPI3
| style="background:#b3bac5; text-align:center"| 7
| style="background:#b3bac5; text-align:center"| 8
| GPI4
| I4
| Digital Input 4
|}

==Power supply==

Das Gerät benötigt ein externes ES1/PS2 DC-Netzteil 8-30V, 25W.

==Ethernet==

10/100MBit Ethernet-Schnittstelle, standardmäßig als DHCP-Server mit der IP-Adresse 192.168.1.1 konfiguriert.

==USB==

USB 2.0 Host-Schnittstelle zum Anschluss von externen USB-Geräten. Bitte beachten Sie, dass für viele Geräte ein entsprechender Linux-Treiber erforderlich ist.

==SD card==

Micro SD-Kartenschnittstelle zum Hinzufügen von zusätzlichem nichtflüchtigem Speicher zum System. Bitte verwenden Sie eine SD-Karte, um sich schnell ändernde Daten (z. B. Datenbanken usw.) zu speichern, da der interne Flash-Speicher nur eine begrenzte Anzahl von Schreibzyklen zulässt, bevor es zu einer Beschädigung des Speichers kommen kann.

==CAN==

Die Schnittstelle gemäß der CAN 2.0B-Protokollspezifikation wird über die Flexcan-Schnittstelle des i.MX7D und einen NXP TJA1051-Transceiver realisiert. Sie verfügt über einen schaltbaren 120R-Abschlusswiderstand.

Auf der Linux-Seite wird eine SocketCAN-Schnittstelle (can0) mit einer Standard-Bitrate von 250.000 bit/s bereitgestellt.

Der Abschlusswiderstand wird aktiviert, indem CAN_TERM_EN_n auf Low gesetzt wird. Siehe Linux-Zuordnung für Details.

==RS485==

Eine nicht-isolierte RS485-Schnittstelle ist als /dev/ttymxc3 verfügbar. Die Schnittstelle enthält keinen Abschlusswiderstand.

==RS232==

Eine 4-Draht-RS232-Schnittstelle ist als /dev/ttymxc2 verfügbar.

==1-wire==

Der GW4100 enthält einen DS2482 I2C zu 1-Wire Brückenbaustein von Maxim Integrated (https://www.maximintegrated.com/en/products/interface/controllers-expanders/DS2482-100.html#). Der entsprechende Treiber ist in den Linux-Mainline-Kernel integriert und alle 1-Wire-Funktionen sind dem sysfs-Dateisystem ausgesetzt.

Vergleiche https://www.kernel.org/doc/html/latest/w1/w1-generic.html für eine detaillierte Beschreibung.

==Digital inputs==

Die folgende Abbildung zeigt den internen Aufbau der vier digitalen Eingänge:

[[Datei:GPINx.png ]]

Dieses Design ermöglicht den Anschluss von Push-Pull- und Open-Collector-Ausgängen mit einer Schwelle von etwa 4,5 V. Es ist auch möglich, einen mechanischen Schalter oder ein Relais zu verwenden, um den Eingang mit GND zu verbinden, ohne dass ein zusätzlicher Pullup-Widerstand erforderlich ist.

Das folgende Diagramm zeigt einen vereinfachten Aufbau:

[[Datei:GPINxSim.png ]]

Bitte beachten Sie, dass der Eingang intern invertiert ist, d.h. wenn der Eingang entweder unbeschaltet oder mit einer Spannung oberhalb des Schwellenwerts verbunden ist, wird er als logische 0 (niedriger Pegel) gelesen, wenn er mit einer Spannung unterhalb des Schwellenwerts (z.B. 0 V) verbunden ist, wird er als logische 1 (hoher Pegel) gelesen.

Die GPIs sind dem sysfs-Dateisystem auf der Linux-Seite ausgesetzt und können zur Bequemlichkeit des Benutzers automatisch wieder invertiert werden.

TODO: add linux example

==Multi-purpose I/O==

Der Baustein enthält zwei Mehrzweck-GPIOs, die als Ein- oder Ausgang konfiguriert werden können. Bei Bedarf kann ein interner Pullup-Widerstand aktiviert werden.

Außerdem kann der GPIO als Analogeingang verwendet werden, da die Eingangsspannung auch mit einem der internen 12-Bit-ADC-Kanäle (s. On-Board-ADCs) verbunden ist.

[[Datei:MultiPurposeGPIO.png ]]

Der GPIO ist im High- und Lowside-Strompfad strombegrenzt (tbd mA), so dass das gleichzeitige Schließen von High- und Lowside-Schaltern das Gerät nicht beschädigt (ebenso wenig wie ein externer Kurzschluss), dennoch wird davon abgeraten, dies zu tun und stattdessen eine Break-before-Make-Logik zu verwenden.

TODO: add linux example

==GSM==

LTE-Konnektivität mit Fallback zu 3G und 2G wird durch ein integriertes Quectel EC21-Modul bereitgestellt. Auf der Linux-Seite wird das Gerät von ModemManager gesteuert (siehe https://core.docs.ubuntu.com/en/stacks/network/modem-manager/docs/).

Der ModemManager verwendet /dev/ttyUSB3 für die Kommunikation mit dem EC21, /dev/ttyUSB2 ist für die Ausführung von AT-Befehlen aus dem Userspace verfügbar.

Der Status des GSM-Moduls kann zusätzlich mit Hilfe von GSM_PWR_IND_n überwacht werden, das low getrieben wird, wenn das Modul eingeschaltet ist.

Das GW4100 enthält zwei SIM-Kartenhalter, die die Verwendung von 2FF (Mini-SIM) oder 3FF (Micro-SIM) Karten ermöglichen. Es ist möglich, beide Karten zu bestücken, um z. B. die Nutzung verschiedener Netze zu ermöglichen. Die aktive SIM-Karte wird durch das folgende Verfahren ausgewählt.

===SIM Auswahlverfahren===

Zunächst muss die EC21 über AT-Befehle so konfiguriert werden, dass ein SIM-Hot-Swapping möglich ist:

((ABB))

Bitte beachten Sie, dass ein Neustart des Moduls mit AT+CFUN erforderlich ist, die Einstellung bleibt dann erhalten.

Als nächstes muss die SIM "logisch entfernt" werden, indem SIM_EN auf low gesetzt wird.

Danach kann die aktive SIM mit SIM_SEL ausgewählt werden (default high -> 2FF SIM)

TODO: check if accessible old/new interface

===Aktivieren der Datenverbindung===

Das Modem kann dann wie folgt verwendet werden:
<pre>
root@Gateway:~ mmcli -m 0
--------------------------------
General | dbus path: /org/freedesktop/ModemManager1/Modem/0
| device id: dd1983f3c13bd25a19647d2fca076dad57ef5c57
--------------------------------
Hardware | manufacturer: Quectel
| model: EC21
| firmware revision: EC21EFAR06A02M4G
| supported: gsm-umts, lte
| current: gsm-umts, lte
| equipment id: 867962042149685
--------------------------------
System | device: /sys/devices/platform/soc/30800000.bus/30b30000.usb/ci_hdrc.1/usb1/1-1/1-1.1
| drivers: option1
| plugin: Quectel
| primary port: ttyUSB2
| ports: ttyUSB0 (qcdm), ttyUSB2 (at), ttyUSB3 (at)
--------------------------------
Numbers | own: +4915140075573
--------------------------------
Status | unlock retries: sim-pin (3), sim-puk (10), sim-pin2 (3), sim-puk2 (10)
| state: disabled
| power state: on
| signal quality: 0% (cached)
--------------------------------
Modes | supported: allowed: 2g, 3g, 4g; preferred: none
| current: allowed: 2g, 3g, 4g; preferred: none
--------------------------------
IP | supported: ipv4, ipv6, ipv4v6
--------------------------------
3GPP | imei: 867962042149685
--------------------------------
3GPP EPS | ue mode of operation: csps-2
--------------------------------
SIM | dbus path: /org/freedesktop/ModemManager1/SIM/0
</pre>

Nach jedem Reset erhöht das Modem seine Nummer.

So fügen Sie eine neue Verbindung hinzu:

<pre>
root@Gateway:~ nmcli c add type gsm ifname "*" con-name telekom apn "internet.t-mobile"
Connection 'telekom' (17bdada4-4361-4eca-8506-f6eab6b26a48) successfully added.
</pre>

Und dann, um die Verbindung zu aktivieren:

<pre>

root@Gateway:~ nmcli c up telekom
Connection successfully activated (D-Bus active path: /org/freedesktop/NetworkManager/ActiveConnection/3)

root@Gateway:~ mmcli -m 0
--------------------------------
General | dbus path: /org/freedesktop/ModemManager1/Modem/0
| device id: 794eb538900f787165b66d8af66496a4e7cd0c8b
--------------------------------
Hardware | manufacturer: QUALCOMM INCORPORATED
| model: QUECTEL Mobile Broadband Module
| firmware revision: EC21EFAR06A02M4G
| carrier config: default
| h/w revision: 10000
| supported: gsm-umts, lte
| current: gsm-umts, lte
| equipment id: 867962042149685
--------------------------------
System | device: /sys/devices/platform/soc/30800000.bus/30b30000.usb/ci_hdrc.1/usb1/1-1/1-1.1
| drivers: qmi_wwan, option1
| plugin: Quectel
| primary port: cdc-wdm0
| ports: cdc-wdm0 (qmi), ttyUSB0 (qcdm), ttyUSB2 (at), wwan0 (net),
| ttyUSB3 (at)
--------------------------------
Numbers | own: 4915140075573
--------------------------------
Status | lock: sim-pin2
| unlock retries: sim-pin (3), sim-puk (10), sim-pin2 (3), sim-puk2 (10)
| state: connected
| power state: on
| access tech: gsm
| signal quality: 41% (recent)
--------------------------------
Modes | supported: allowed: 2g; preferred: none
| allowed: 3g; preferred: none
| allowed: 4g; preferred: none
| allowed: 2g, 3g; preferred: 3g
| allowed: 2g, 3g; preferred: 2g
| allowed: 2g, 4g; preferred: 4g
| allowed: 2g, 4g; preferred: 2g
| allowed: 3g, 4g; preferred: 3g
| allowed: 3g, 4g; preferred: 4g
| allowed: 2g, 3g, 4g; preferred: 4g
| allowed: 2g, 3g, 4g; preferred: 3g
| allowed: 2g, 3g, 4g; preferred: 2g
| current: allowed: 2g, 3g, 4g; preferred: 4g
--------------------------------
Bands | supported: egsm, dcs, utran-1, utran-5, utran-8, eutran-1, eutran-3,
| eutran-5, eutran-7, eutran-8, eutran-20
| current: egsm, dcs, utran-1, utran-5, utran-8, eutran-1, eutran-3,
| eutran-5, eutran-7, eutran-8, eutran-20
--------------------------------
IP | supported: ipv4, ipv6, ipv4v6
--------------------------------
3GPP | imei: 867962042149685
| operator id: 26201
| registration: home
--------------------------------
3GPP EPS | ue mode of operation: csps-2
--------------------------------
SIM | dbus path: /org/freedesktop/ModemManager1/SIM/0
--------------------------------
Bearer | dbus path: /org/freedesktop/ModemManager1/Bearer/0
</pre>

==GNSS==

Für die Geopositionierung steht ein im Quectel EC21 Modul integrierter GNSS-Empfänger zur Verfügung. Die NMEA-Daten werden auf /dev/ttyUSB1 ausgegeben. Der GNSS-Empfänger wird mit dem folgenden AT-Befehl aktiviert:

AT+QGPS=1

Eine detaillierte Beschreibung der verfügbaren Konfigurationsoptionen finden Sie in der EC21-Dokumentation (https://www.quectel.com/product/ec21.htm).

Die aktive Antennenversorgung wird durch den Regler 9 des Qorvo ACT8847 Power Management ic (PMIC) bereitgestellt. Folgende Befehle aus dem Anwenderbereich sind erforderlich, um die Versorgung zu aktivieren:

<pre>
# regulator 3.0V
i2cset -y 2 0x5a 0x70 0x36 i
# regulator on
i2cset -y 2 0x5a 0x71 0x80 i
</pre>

==User LEDs==

Das Gerät enthält zwei vom Benutzer steuerbare LEDs (z. B. zur Statusanzeige). Diese sind im sysfs unter /sys/class/leds/ zu finden. Siehe Linux-Zuordnung für Details.

Bitte vergleiche https://www.kernel.org/doc/Documentation/leds/leds-class.txt für weitere Details.

==User Button==

Für benutzerdefinierte Funktionen (z.B. Rücksetzen auf Werkseinstellungen) steht eine versiegelte Taste zur Verfügung.

TODO: add linux example, picture

==On board ADCs==

Das folgende Diagramm zeigt die Verwendung der acht 12-Bit-ADCs des i.MX7D-Prozessors.

[[Datei:ADC_internal.png ]]

ADC 0 ermöglicht den Zugriff auf die Spannungspegel der beiden Mehrzweck-GPIOs und die Versorgungsspannung sowie eine Temperaturanzeige der Karte, während ADC 1 zur Überwachung des Systemzustands verwendet wird.

Alle ADC-Werte sind vom Linux-Benutzerbereich aus über die sysfs-Zuordnung (/sys/bus/iio/devices/) zugänglich.

Beispiel 1: Ablesen des Istwerts der 5-V-Versorgungsspur

<pre>
root@Gateway:~ cat /sys/bus/iio/devices/iio:device1/in_voltage0_raw
3789
</pre>

Berechnung der Spannung:

[[Datei:on board 3.png ]]

Beispiel 2: Ablesen der Versorgungsspannung des Systems

<pre>
root@Gateway:~ cat /sys/bus/iio/devices/iio:device0/in_voltage2_raw
2145
</pre>

Berechnung der Spannung:

[[Datei:on board 5.png ]]

Bitte beachten Sie, dass die Messung hinter der Eingangsdiode erfolgt und daher die tatsächliche Versorgungsspannung um ca. 0,5V höher ist (in diesem Fall beträgt die tatsächliche Versorgungsspannung 24V).

Beispiel 3: Ablesen der Platinentemperatur

<pre>
root@Gateway:~ cat /sys/bus/iio/devices/iio:device0/in_voltage3_raw
2576
</pre>

Berechnung des NTC-Widerstands:

[[Datei:on board 7.png ]]

[[Datei:on board 8.png ]]

[[Datei:on board 9.png ]]

Wenn man die Widerstandsnachschlagetabelle im Datenblatt der Widerstände (NCP15XV103J03RC) zu Rate zieht, liegt die Temperatur auf der Platine bei etwa 37°C.

=Linux mapping=
==Digital and analog I/Os (deprecated sysfs mapping)==

{| class="wikitable" width="40%"
! Signal !! Linux mapping !! Typ
|-
| GPIN1
| style="text-align:right" | /sys/class/gpio10
| rowspan="4" | digital inputs
|-
| GPIN2
| style="text-align:right" | /sys/class/gpio11
|-
| GPIN3
| style="text-align:right" | /sys/class/gpio14
|-
| GPIN4
| style="text-align:right" | /sys/class/gpio15
|-
| GPIO0_IN_n
| style="text-align:right" | /sys/class/gpio3
| rowspan="10" | Multi-purpose I/Os
|-
| GPIO0_ADC
| style="text-align:right" | /sys/bus/iio/devices/iio:device0/in_voltage0_raw
|-
| GPIO0_HIGHSIDE
| style="text-align:right" | /sys/class/gpio0
|-
| GPIO0_LOWSIDE
| style="text-align:right" | /sys/class/gpio1
|-
| GPIO0_PULLUP
| style="text-align:right" | /sys/class/gpio2
|-
| GPIO1_IN_n
| style="text-align:right" | /sys/class/gpio9
|-
| GPIO1_ADC
| style="text-align:right" | /sys/bus/iio/devices/iio:device0/in_voltage0_raw
|-
| GPIO1_HIGHSIDE
| style="text-align:right" | /sys/class/gpio4
|-
| GPIO1_LOWSIDE
| style="text-align:right" | /sys/class/gpio5
|-
| GPIO1_PULLUP
| style="text-align:right" | /sys/class/gpio8
|-
| LED_USR1
| style="text-align:right" | /sys/class/leds/iotmaxx:green:usr1/
| LED B
|-
| LED_USR2
| style="text-align:right" | /sys/class/leds/iotmaxx:green:usr2/
| LED A
|-
| PBSTAT_IRQ_n
| style="text-align:right" | /sys/class/gpio33
| PMIC PBSTAT IRQ
|-
| 5V_PERIPH_EN
| style="text-align:right" | /sys/class/gpio34
| N/A, always on
|-
| ACT8847_IRQ_n
| style="text-align:right" | /sys/class/gpio90
| PMIC IRQ
|-
| RTC_INTA_n
| style="text-align:right" | /sys/class/gpio61
| RTC IRQ
|-
| USR_SWITCH_n
| style="text-align:right" | /sys/class/gpio91
| User switch
|-
| SIM_ENABLE
| style="text-align:right" | /sys/class/gpio89
| rowspan="2" | SIM select
|-
| SIM_SEL
| style="text-align:right" | /sys/class/gpio112
|-
| CAN_TERM_EN_n
| style="text-align:right" | /sys/class/gpio108
| CAN termination resistor
|-
| GSM_PWR_IND_n
| style="text-align:right" | /sys/class/gpio115
| GSM power indicator
|}

==Digital and analog I/Os (new libgpiod mapping)==

{| class="wikitable" width="40%"
! Signal !! Linux mapping !! line !! Typ
|-
| GPIN1
| style="text-align:right" | gpiochip0
| line 10
| rowspan="4" | digital inputs
|-
| GPIN2
| style="text-align:right" | gpiochip0
| line 11
|-
| GPIN3
| style="text-align:right" | gpiochip0
| line 14
|-
| GPIN4
| style="text-align:right" | gpiochip0
| line 15
|-
| GPIO0_IN_n
| style="text-align:right" | gpiochip0
| line 13
| rowspan="10" | Multi-purpose I/Os
|-
| GPIO0_ADC
| style="text-align:right" | /sys/bus/iio/devices/iio:device0/in_voltage0_raw
|
|-
| GPIO0_HIGHSIDE
| style="text-align:right" | gpiochip0
| line 0
|-
| GPIO0_LOWSIDE
| style="text-align:right" | gpiochip0
| line 1
|-
| GPIO0_PULLUP
| style="text-align:right" | gpiochip0
| line 2
|-
| GPIO1_IN_n
| style="text-align:right" | gpiochip0
| line 9
|-
| GPIO1_ADC
| style="text-align:right" | /sys/bus/iio/devices/iio:device0/in_voltage1_raw
|
|-
| GPIO1_HIGHSIDE
| style="text-align:right" | gpiochip0
| line 4
|-
| GPIO1_LOWSIDE
| style="text-align:right" | gpiochip0
| line 5
|-
| GPIO1_PULLUP
| style="text-align:right" | gpiochip0
| line 8
|-
| LED_USR1
| style="text-align:right" | /sys/class/leds/iotmaxx:green:usr1/
|
| LED B
|-
| LED_USR2
| style="text-align:right" | /sys/class/leds/iotmaxx:green:usr2/
|
| LED A
|-
| PBSTAT_IRQ_n
| style="text-align:right" | gpiochip1
| line 1
| PMIC PBSTAT IRQ
|-
| 5V_PERIPH_EN
| style="text-align:right" | gpiochip1
| line 2
| N/A, always on
|-
| ACT8847_IRQ_n
| style="text-align:right" | gpiochip2
| line 26
| PMIC IRQ
|-
| RCT_INTA_n
| style="text-align:right" | gpiochip1
| line 29
| RTC IRQ
|-
| USR_SWITCH_n
| style="text-align:right" | gpiochip2
| line 27
| USER switch
|-
| SIM_ENABLE
| style="text-align:right" | gpiochip2
| line 25
| rowspan="2" | SIM select
|-
| SIM_SEL
| style="text-align:right" | gpiochip3
| line 16
|-
| CAN_TERM_EN_n
| style="text-align:right" | gpiochip3
| line 12
| CAN termination resistor
|-
| GSM_PWR_IND_n
| style="text-align:right" | gpiochip3
| line 19
| GSM power indicator
|}

==GPIO Linux User-Space Beispiele (veraltetes sysfs-Mapping)==

Beispiel: Exportieren und Lesen von GPIN1 (High-Pegel am Eingangs-Pin)

<pre>
root@Gateway:~ echo 11 > /sys/class/gpio/export
root@Gateway:~ echo 1 > /sys/class/gpio/gpio11/active_low
root@Gateway:~ cat /sys/class/gpio/gpio11/value
1
</pre>

Beispiel: Exportieren und Aktivieren von GPIO1 Pullup

<pre>
root@Gateway:~ echo 8 > /sys/class/gpio/export
root@Gateway:~ echo high > /sys/class/gpio/gpio8/direction
</pre>

Vergleiche https://www.kernel.org/doc/html/latest/admin-guide/gpio/sysfs.html für eine detaillierte Beschreibung der sysfs-Gpio-Schnittstelle.

==GPIO Linux User-Space Beispiele (neue libgpiod-Zuordnung)==

Beispiel: Lesen von GPIN1 (High-Pegel am Eingangs-Pin), kein Export erforderlich

<pre>
root@Gateway:~ gpioget --active-low gpiochip0 11
1
</pre>

Beispiel: GPIO1 Pullup aktivieren, kein Export erforderlich

<pre>
gpioset gpiochip0 8=1
</pre>

Vergleiche https://git.kernel.org/pub/scm/libs/libgpiod/libgpiod.git/tree/README für eine Beschreibung der libgpiod-Schnittstelle.

==Serielle Schnittstellen und Busse==

{| class="wikitable" width="40%"
! Interface or bus !! Linux mapping !!
|-
| RS232
| style="text-align:right" | /dev/ttymxc2
| rowspan="2" | linux console
|-
| RS485
| style="text-align:right" | /dev/ttymxc3
|-
| 1-wire
| style="text-align:right" | /sys/bus/w1/
| rowspan="3" | see kernel.org
|-
| CAN
| style="text-align:right" | can0 network interface
|-
| Ethernet
| style="text-align:right" | eth network interface
|-
| USB
|
| device dependent
|}