gdprJson - dialect/mod.ts - @hertzg/tplink-api documentation

variable gdprJson

EU/GDPR firmware speaking a JSON payload format over /cgi_gdpr?9.

Differences from gdprText:

Concern	`gdprText`	`gdprJson`
Command endpoint	`/cgi_gdpr`	`/cgi_gdpr?9`
Public key endpoint	`/cgi/getParm`	`/cgi/getGDPRParm`
Login	own endpoint `/cgi/login`, envelope in the query string	a command posted to `/cgi_gdpr?9`
Default username	`admin`	`user`
Credentials	`username\npassword`	base64 fields inside JSON
Payload	bracketed text blocks	JSON envelope
Operations	`1`, `2`, …	`go`, `gl`, `gs`, `so`, `ao`, `do`, `op`, `cgi`
Stack default	`0,0,0,0,0,0`	`0,0,0,0,0,0`
Batching	N actions per request	one action per request
Session cookie	`loginErrorShow` + `JSESSIONID`	`JSESSIONID` only

Responses come in two shapes: go and gl answer with a JSON envelope, cgi answers with the plain-text $.ret=<code> form. decodeCommand handles both and assumes writes answer with one of the two as well.

Examples

Encode a login payload

import { assertEquals } from "@std/assert";
import { gdprJson } from "./gdprJson.ts";

assertEquals(
  gdprJson.encodeLogin({ username: "user", password: "hunter2" }),
  '{"data":{"UserName":"dXNlcg==","Passwd":"aHVudGVyMg==","Action":"1",' +
    '"stack":"0,0,0,0,0,0","pstack":"0,0,0,0,0,0"},' +
    '"operation":"cgi","oid":"/cgi/login"}',
);

One request per action

import { assertEquals } from "@std/assert";
import { ACT } from "./dialect.ts";
import { gdprJson } from "./gdprJson.ts";

const batches = gdprJson.encodeCommands([
  [ACT.GET, "DEV2_DEV_INFO"],
  [ACT.GL, "DEV2_LTE_SERVING_CELL_INFO"],
]);

assertEquals(batches.length, 2);
assertEquals(batches[0].indices, [0]);
assertEquals(batches[1].indices, [1]);

Decode a list response

import { assertEquals } from "@std/assert";
import { gdprJson } from "./gdprJson.ts";

const decoded = gdprJson.decodeCommand(
  '{"success":true,"data":[{"band":"n78"},{"band":"1"}]}',
  { payload: "", indices: [3] },
);

assertEquals(decoded.error, null);
assertEquals(decoded.results, [[{ band: "n78" }, { band: "1" }]]);

Decode the plain-text reply of a `cgi` operation

import { assertEquals } from "@std/assert";
import { gdprJson } from "./gdprJson.ts";

const decoded = gdprJson.decodeCommand("$.ret=0;", {
  payload: "",
  indices: [0],
});

assertEquals(decoded.error, null);
assertEquals(decoded.results, [null]);

Type

Dialect