> For the complete documentation index, see [llms.txt](https://zmink.gitbook.io/node-tcrouter/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://zmink.gitbook.io/node-tcrouter/master.md).

# Welcome

## Node TC Router

[![Build Status](https://travis-ci.org/PhoenixContactUSA/node-tcrouter.svg?branch=master)](https://travis-ci.org/PhoenixContactUSA/node-tcrouter) [![codecov](https://codecov.io/gh/PhoenixContactUSA/node-tcrouter/branch/master/graph/badge.svg)](https://codecov.io/gh/PhoenixContactUSA/node-tcrouter)

This Nodejs package enables communication with the Phoenix Contact TC Router. The TC Router is a 4G industrial router with built in firewall and networking services. This driver supports basic status information collection, controlling and reading IO, sending and receiving text messages, and sending emails.

```bash
npm i --save @phoenixcontactusa/node-tcrouter
```

Before being able to communicate with a TC Router device, you'll need to set up the "socket server" feature of the device. More information on this can be found in [hardware setup](/node-tcrouter/setup/device-setup.md).

The TCRouter class constructor accepts 3 arguments

```javascript
//TCRouter(ip,remotePort,timeout)
//ip - ip address of the TC Router
//remotePort - open port on the TC Router (1432 by default)
//timeout - timeout in millseconds before closing client connection
var router = new TCRouter("192.168.0.1", 1432, 5000);
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://zmink.gitbook.io/node-tcrouter/master.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.