farlepet/coapserver-extra repository overview

GitHub repository: https://github.com/farlepet/coapserver⁠

This version of coapserver includes the following extra tools that can be used with the command feature:

• Compression/decompression utilities:
  • lz4
  • gzip
  • xz
• Protocol decoding/encoding utilities:
  • MSGPACK (https://github.com/ludocode/msgpack-tools.git⁠)
    • msgpack2json
    • json2msgpack
  • CBOR (https://github.com/cabo/cbor-diag⁠)
    • cbor2json
    • json2cbor
    • (And equivalent commands for YAML)

⁠Coap Server

This CoAP server is designed to be highly configurable to allow its use with a variety of IoT devices, for testing or for low-scale use.

Current Features:

• CoAP via UDP, DTLS, TCP, and TLS
  • Currently only PEM keys/certificates are supported
• GET, PUT, and POST
  • GET: Returns the value of the resource
  • PUT,POST: Print the sent data, and/or set the current value of the resource
• Resource observation
• Multiple data format support
  • STRING - Plaintext
  • HEX - Raw data represented as hex
  • BASE64 - Raw data represented as base64
• Logging to a separate file for each resource
• Execute external command on request data
  • By piping request data via stdin, or passing in via environment variable
• Templated resource configuration for creating multiple similar resources
• Regex-based on-the-fly resource creation
• Multi-block requests
  • Currently no support for multi-block responses

⁠Running via Docker

docker run -it --rm -p 5683:5683/udp \
           --mount type=bind,source=$PWD/config.json,target=/config.json,Z \
           --mount type=bind,source=$PWD/logs/,target=/var/log/coapserver,Z \
           farlepet/coapserver:<version> \
           -c /config.json -l /var/log/coapserver

OR

docker run -it --rm -p 5683:5683/udp \
           --mount type=bind,source=$PWD/config.json,target=/config.json,Z \
           --mount type=bind,source=$PWD/logs/,target=/var/log/coapserver,Z \
           farlepet/coapserver-extra:<version> \
           -c /config.json -l /var/log/coapserver