Skip to content

CANServer v2 Client Identification Protocol

Jump to bottom
Chris Whiteford edited this page Dec 22, 2022 · 4 revisions

Firmware v2 Manual

Manual Root

Client Identification Protocol

When a client device wants to register with a CANServer it can make a HTTP POST request to http://192.168.4.1/network/internal/associate

The payload of this request should contain the following json:

{
    "name":"Client's Friendly Name",
    "settings":"proxy"
}

The payload should be tagged with a Content-Type of application/json

The CANServer will respond with a HTTP 200 status code if all goes well. Any other status code is indicative of an error.

The name member of the above json will get displayed alongside the Client's MAC and IP address on the CANServer's Network tab. This can be a helpful way for users to know what clients/devices are connected.

The settings member of the above json payload currently only supports the proxy value. This will cause the CANServer to proxy connections from its external network to the internal network to this specific client. This will also trigger an additional icon to be displayed next to the client's friendly name on the CANServer's Network tab.

If your client doesn't have any internal settings or doesn't need the proxy feature you can omit the settings member.

Clone this wiki locally