diff --git a/Manual/images/UKCA-mark.jpg b/Manual/images/UKCA-mark.jpg new file mode 100644 index 0000000..65a6d39 Binary files /dev/null and b/Manual/images/UKCA-mark.jpg differ diff --git a/Manual/images/bottom-circled.png b/Manual/images/bottom-circled.png new file mode 100644 index 0000000..8db9c1c Binary files /dev/null and b/Manual/images/bottom-circled.png differ diff --git a/Manual/images/ce-mark.png b/Manual/images/ce-mark.png new file mode 100644 index 0000000..bc0a422 Binary files /dev/null and b/Manual/images/ce-mark.png differ diff --git a/Manual/images/opencom-lte-b.png b/Manual/images/opencom-lte-b.png new file mode 100644 index 0000000..204ba49 Binary files /dev/null and b/Manual/images/opencom-lte-b.png differ diff --git a/Manual/images/opencom-lte.png b/Manual/images/opencom-lte.png new file mode 100644 index 0000000..8e50103 Binary files /dev/null and b/Manual/images/opencom-lte.png differ diff --git a/Manual/images/sma-circled.png b/Manual/images/sma-circled.png new file mode 100644 index 0000000..cfa5a2f Binary files /dev/null and b/Manual/images/sma-circled.png differ diff --git a/Manual/images/test-points-circled.png b/Manual/images/test-points-circled.png new file mode 100644 index 0000000..0ff49b6 Binary files /dev/null and b/Manual/images/test-points-circled.png differ diff --git a/Manual/images/top-circled.png b/Manual/images/top-circled.png new file mode 100644 index 0000000..4f97d04 Binary files /dev/null and b/Manual/images/top-circled.png differ diff --git a/Manual/main.pdf b/Manual/main.pdf new file mode 100644 index 0000000..afac8fa Binary files /dev/null and b/Manual/main.pdf differ diff --git a/Manual/main.tex b/Manual/main.tex new file mode 100644 index 0000000..71a09b7 --- /dev/null +++ b/Manual/main.tex @@ -0,0 +1,244 @@ +\documentclass[a6paper, 8pt]{extarticle} + +% packages +\usepackage[margin=12mm]{geometry} +\usepackage{graphicx} +\usepackage{multicol} + +\graphicspath{ {./images/} } +\parindent = 0pt % disable annoying indent on paragraphs + +\begin{document} + +\thispagestyle{empty} +\begin{center} + {\huge openCom LTE - User Manual} \\ + LTE connectivity for your Framework Laptop. \\ + \vspace{5mm} + \includegraphics[scale=0.35]{opencom-lte.png} +\end{center} + +\newpage + +\tableofcontents +\setcounter{page}{1} + +\newpage + +\section{Introduction} +Thank you for purchasing the openCom LTE from Liberated Embedded +Systems. + +Within your package you will find the following: +\begin{itemize} + \item \textbf{1x openCom LTE} + \item LTE antenna(s) (if ordered) + \item SMA dust covers (if ordered) + \item 3x assorted stickers + \item This manual +\end{itemize} + +\newpage + +\section{Overview} +Within this section, we provide an overview of notable aspects of the openCom LTE. + +\subsection{Top} + +\begin{multicols}{2} + The openCom LTE supports 3 antenna connections, with these being: + \begin{itemize} + \item An SMA main antenna for LTE connectivity (J1) + \item An SMA diversity antenna to enhance connection reliability (J2) + \item A u.FL GPS antenna for determining location (J3) + \end{itemize} + The LEDs D2 and D3 are status indicators, and are covered in the next + section. + + \columnbreak + \includegraphics[scale=0.27]{top-circled.png} +\end{multicols} +Please note that a GPS antenna is \textbf{not included} with the device, and +one can only be connected with the top cover disassembled. + +\subsubsection{LEDs} +\textbf{D3, or the left LED}, is red, and activates when the device is powered on. + +\textbf{D2, or the right LED}, is red, and flashes differently depending on network status: +\begin{itemize} + \item Short flashing - searching for cell tower + \item Long flashing - idle + \item Quick flicker - data transfer + %\item Constantly on - voice calling +\end{itemize} + + +\subsection{Bottom} +\begin{multicols}{2} + \setlength{\parskip}{0pt} % stop stretching across whole column vertical space + On the rear side of the device, the SIM slot is present, which + accepts a \textbf{nano sized} SIM card. + + \vspace{5mm} + + The SIM can be inserted into the slot by pushing it until it clicks. It + can also be removed by pushing it until it clicks, and it will spring + out after. You may want to consider using the spudger end of your + Framework screwdriver to help insert and remove it. + + \vspace{5mm} + + There are many test points present on rear of the device, which are + documented in the next section. + + \columnbreak + \includegraphics[scale=0.25]{bottom-circled.png} +\end{multicols} + +\newpage + +\subsection{Test points} +\begin{multicols}{2} + \setlength{\parskip}{0pt} % stop stretching across whole column vertical space + There are several test points available on the device, which allow you to + test critical functionality of the device if you so choose. + + These are detailed below: + \begin{itemize} + \item TP1 - USB D+ trace + \item TP2 - USB D- trace + \item TP3 - GND + \item TP4 - USB\_BOOT + \item TP5 - VDD\_EXT + \end{itemize} + + Note that to access TP1 and TP2, the resistor pads R13 and R14 must be + bridged with wire or solder, as 0Ω resistors are not provided here. + + \subsubsection{Emergency download mode} + If necessary, the module can be booted into emergency download mode by + shorting TP4 and TP5 before powering it up. This will allow you to upgrade + the firmware of the module over USB. The firmware upgrade can only be done with the QFlash utility from Quectel, which only works on Windows. A download link is provided in Section \ref{sec:Windows}. + + \columnbreak + \includegraphics[scale=0.25]{test-points-circled.png} +\end{multicols} + +\newpage + +\section{Installation} +\begin{multicols}{2} + In order to use your openCom LTE, you must first connect the external + antenna(s) to facilitate communication. + + Connect an antenna to the \textbf{J1 port} on the device, which is the + right external SMA connector. It is screwed on clockwise. + + Although the diversity antenna on the \textbf{J2 port} is optional, + \textbf{consider also connecting it} to the device in order to ensure an + optimal internet connection. + + + \columnbreak + \includegraphics[scale=0.2]{sma-circled.png} +\end{multicols} + +Your openCom LTE is now assembled and ready to go, and can be inserted into +your Framework Laptop by slotting it into an empty Expansion Card bay. + +\textbf{Remember to insert your SIM card!} + +\newpage + +\section{Usage} +\subsection{Antennas} +If you chose to bring your own LTE antennas at checkout, please ensure you +purchase LTE antennas with a VSWR < 2 for optimal performance. + +Additionally, if you choose to purchase a GPS antenna for your use, ensure it is a passive antenna (active antennas are not supported), with a VSWR <= 2. + +\subsection{Linux} +On Linux you may use NetworkManager with ModemManager to create a connection +for your openCom LTE. With the device plugged in, create a new connection, +choosing "mobile broadband", then progress through the Wizard. If you use +\textbf{Arch Linux}, there are great wiki articles on the subject. + +\subsection{Windows} +\label{sec:Windows} +Download the drivers to interface with your openCom LTE from the following +link: \\ +\texttt{https://link.liberatedsystems.co.uk/EG95} \\ +Within the archive, you will find the executable file to install your drivers. + +\newpage + +\section{Enclosure} +\subsection{Disassembly} +There are two M2 screws on the exterior section of the device which hold on the +lid. Unscrewing them, you can take the lid off, and the LED columns with it +(\textbf{don't lose them!}). + +There are just two M1 screws holding the circuit board onto the bottom of the +enclosure, which when removed allow for the removal of the board. However, we +do not recommend these screws are removed frequently, as their effectiveness +will decrease over time if they are. + +\subsection{Assembly} +Insert the circuit board into the bottom of the enclosure, and fasten it in +with the two M1 screws. + +Insert the LED columns into their respective holes on the lid (upside down). +Then, place the bottom part of the enclosure on top of the lid. Finally, insert +the M2 screws, and screw them into their respective holes on the exterior +section. + +\newpage + +\section{AT commands} +For information concerning the available AT commands, please download the +archive from the following link: \\ +\texttt{https://link.liberatedsystems.co.uk/EG95} \\ +Within, you will find a copy of the AT command manual for your openCom LTE, +which utilises Quectel's EG95 module. + +\section{Durability} +Please be careful of the conditions in which you use this device, do not expose +it to rain or submerge it in bodies of water. + + +\section{Warranty} +Please follow the below URL in order to access information about your +warranty. +\\\texttt{https://store.liberatedsystems.co.uk/opencom-lte-warranty} + +\newpage + +\section{Contact} +If you have any issues with your openCom LTE, please reach out to us. You can +contact us via email or XMPP at \\\texttt{contact@liberatedsystems.co.uk}. + +\section{Legal} +Liberated Embedded Systems Ltd. is registered in England and Wales +(company no. 14722578). Our registered business address is +Portland House, Bute Street, Cardiff, CF10 5EQ. \\ + +We are not to be held responsible if the customer chooses to download +classified F35 schematics using our product, to build their own in their +garage. + +\newpage + +\begin{center} + \includegraphics[scale=0.35]{opencom-lte-b.png} +\end{center} + +\thispagestyle{empty} +\vspace{1.3cm} +\begin{center} + \begin{multicols}{2} + \includegraphics{UKCA-mark.jpg} + + \includegraphics[scale=0.08]{ce-mark.png} + \end{multicols} +\end{center} +\end{document}