tl-api

TP-Link Router API (EU GDPR versions)

Tested on TL-MR6400 should work on others as well

Example

$ npm i tpapi

# or

$ yarn add tpapi

import { ACT, authenticate, execute } from "tl-api";

const baseUrl = "http://192.168.1.1";

const { info, ...context } = await authenticate(baseUrl, {
  password: "admin",
});
console.log("info: %j", info);
console.log("sess: %j", context.sessionId);
console.log("tokn: %j", context.tokenId);

const result = await execute(
  baseUrl,
  [
    [
      ACT.GL,
      "LAN_WLAN",
      [
        "name",
        "Standard",
        "SSID",
        "BSSID",
        "X_TP_Band",
        "PossibleChannels",
        "AutoChannelEnable",
        "Channel",
        "X_TP_Bandwidth",
        "Enable",
        "BasicEncryptionModes",
        "BeaconType",
      ],
    ],
  ],
  context
);
console.dir(result, { depth: 4 });

Usage

Once authenticated you will need to use the execute function and pass it an array of actions.

Actions

Actions is an array of operations you want to perform. Each operation is defined as an array in the following format

Format:

[
  [<actionType>, <actionOperationId>, <actionAttributesOrFields>, <stack>, <pStack>],
]

Field	Required	Default	Type	Description	Example
<actionType>	Yes	-	number	Action type, can be any of ACT.*	ACT.GET
<actionOperationId>	Yes	-	string	String representing the operation	"LTE_BANDINFO"
<actionAttributesOrFields>	No	[]	string[] or Record<string, any>	Optional list or a key value map of attributes. Writes usually need a map and reads, specifically reading lists requires fields as array. Not all operations require attributes, for such cases you can skip or use an empty array [] or object {}.	{pageNumber: 12} or ['index', 'from', 'content', 'unread']
<stack>	No	"0,0,0,0,0,0"	string	Not really sure what this does but some <actionOperationId>s require specific "stacks". If ommited the default all zeros are used.	"2,1,0,0,0,0"
<pStack>	No	"0,0,0,0,0,0"	string	Not sure if this is used by the device at all, almost always this stays as default all zeros.	"0,0,0,0,0,0"

Examples:

const getLteBandInfo = [[ACT.GET, "LTE_BANDINFO"]];

const getTotalUnreadSmsMessages = [
  [ACT.GET, "LTE_SMS_UNREADMSGBOX", ["totalNumber"]],
];

const getUnreadSmsMessageBoxPage = [
  [ACT.SET, "LTE_SMS_UNREADMSGBOX", { pageNumber: 1 }],
  [
    ACT.GS,
    "LTE_SMS_UNREADMSGENTRY",
    ["index", "from", "content", "receivedTime", "unread"],
  ],
];

const performLogout = [[ACT.CGI, "cgi/logout"]];

Response

{
  error: 0,
  // error code or 0 if success
  actions: [
    // actions array is in the same order as the actions to be performed
    {
      req: [1, "LTE_BANDINFO"],
      // original actions that got executed
      res: {
        // resulting object or an array if the request was ACT.GS or ACT.GL
        stack: "0,0,0,0,0,0",
        attributes: {
          // Attributes related to this particular request
          LTE_RadioInterface: "8",
          LTE_ActiveBand: "122",
          LTE_ActiveChannel: "1699",
        },
      },
    },
  ],
}