dandri/MeshCore
1
0
Fork 0
mirror of https://github.com/meshcore-dev/MeshCore.git synced 2026-04-26 00:02:12 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
f1d489d758b71fe03cd9f322c351e8dfd7d6a136
MeshCore/kiss_modem_protocol/index.html
ripplebiz f1d489d758 deploy: dee3e26ac0
2026-04-19 01:35:26 +00:00

2153 lines
44 KiB
HTML
Raw Blame History

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="description" content="Documentation for the open source MeshCore firmware">
<link rel="canonical" href="https://meshcore-dev.github.io/meshcore/kiss_modem_protocol/">
<link rel="prev" href="../faq/">
<link rel="next" href="../nrf52_power_management/">
<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.6">
<title>MeshCore KISS Modem Protocol - MeshCore Docs</title>
<link rel="stylesheet" href="../assets/stylesheets/main.484c7ddc.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<link rel="stylesheet" href="../_stylesheets/extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#meshcore-kiss-modem-protocol" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header md-header--shadow" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href=".." title="MeshCore Docs" class="md-header__button md-logo" aria-label="MeshCore Docs" data-md-component="logo">
<img src="../_assets/meshcore.svg" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
MeshCore Docs
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
MeshCore KISS Modem Protocol
</span>
</div>
</div>
</div>
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
</button>
</nav>
<div class="md-search__suggest" data-md-component="search-suggest"></div>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://github.com/meshcore-dev/meshcore/" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v121.9c25.3 12.5 22.3 41.8 9.1 55-6.4 6.4-15.2 10.1-24.3 10.1s-17.8-3.6-24.3-10.1c-17.6-17.6-11.1-46.9 11.2-56v-123c-20.8-8.5-24.6-30.7-18.6-45L142.6 101 8.5 235.1C3 240.6 0 247.9 0 255.5s3 15 8.5 20.4l195.6 195.7c5.4 5.4 12.7 8.4 20.4 8.4s15-3 20.4-8.4l194.7-194.7c5.4-5.4 8.4-12.8 8.4-20.4s-3-15-8.4-20.4"/></svg>
</div>
<div class="md-source__repository">
meshcore-dev/meshcore
</div>
</a>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href=".." title="MeshCore Docs" class="md-nav__button md-logo" aria-label="MeshCore Docs" data-md-component="logo">
<img src="../_assets/meshcore.svg" alt="logo">
</a>
MeshCore Docs
</label>
<div class="md-nav__source">
<a href="https://github.com/meshcore-dev/meshcore/" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v121.9c25.3 12.5 22.3 41.8 9.1 55-6.4 6.4-15.2 10.1-24.3 10.1s-17.8-3.6-24.3-10.1c-17.6-17.6-11.1-46.9 11.2-56v-123c-20.8-8.5-24.6-30.7-18.6-45L142.6 101 8.5 235.1C3 240.6 0 247.9 0 255.5s3 15 8.5 20.4l195.6 195.7c5.4 5.4 12.7 8.4 20.4 8.4s15-3 20.4-8.4l194.7-194.7c5.4-5.4 8.4-12.8 8.4-20.4s-3-15-8.4-20.4"/></svg>
</div>
<div class="md-source__repository">
meshcore-dev/meshcore
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<span class="md-ellipsis">
Introduction
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../cli_commands/" class="md-nav__link">
<span class="md-ellipsis">
CLI Commands
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../companion_protocol/" class="md-nav__link">
<span class="md-ellipsis">
Companion Protocol
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../docs/" class="md-nav__link">
<span class="md-ellipsis">
Local Documentation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<span class="md-ellipsis">
Frequently Asked Questions
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
MeshCore KISS Modem Protocol
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
MeshCore KISS Modem Protocol
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#serial-configuration" class="md-nav__link">
<span class="md-ellipsis">
Serial Configuration
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#frame-format" class="md-nav__link">
<span class="md-ellipsis">
Frame Format
</span>
</a>
<nav class="md-nav" aria-label="Frame Format">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#type-byte" class="md-nav__link">
<span class="md-ellipsis">
Type Byte
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#standard-kiss-commands" class="md-nav__link">
<span class="md-ellipsis">
Standard KISS Commands
</span>
</a>
<nav class="md-nav" aria-label="Standard KISS Commands">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#host-to-tnc" class="md-nav__link">
<span class="md-ellipsis">
Host to TNC
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#tnc-to-host" class="md-nav__link">
<span class="md-ellipsis">
TNC to Host
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#csma-behavior" class="md-nav__link">
<span class="md-ellipsis">
CSMA Behavior
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#sethardware-extensions-0x06" class="md-nav__link">
<span class="md-ellipsis">
SetHardware Extensions (0x06)
</span>
</a>
<nav class="md-nav" aria-label="SetHardware Extensions (0x06)">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#frame-format_1" class="md-nav__link">
<span class="md-ellipsis">
Frame Format
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#request-sub-commands-host-to-tnc" class="md-nav__link">
<span class="md-ellipsis">
Request Sub-commands (Host to TNC)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#response-sub-commands-tnc-to-host" class="md-nav__link">
<span class="md-ellipsis">
Response Sub-commands (TNC to Host)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#error-codes" class="md-nav__link">
<span class="md-ellipsis">
Error Codes
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#unsolicited-events" class="md-nav__link">
<span class="md-ellipsis">
Unsolicited Events
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#data-formats" class="md-nav__link">
<span class="md-ellipsis">
Data Formats
</span>
</a>
<nav class="md-nav" aria-label="Data Formats">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#radio-parameters-setradio-radio-response" class="md-nav__link">
<span class="md-ellipsis">
Radio Parameters (SetRadio / Radio response)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#version-version-response" class="md-nav__link">
<span class="md-ellipsis">
Version (Version response)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#encrypted-encrypted-response" class="md-nav__link">
<span class="md-ellipsis">
Encrypted (Encrypted response)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#airtime-airtime-response" class="md-nav__link">
<span class="md-ellipsis">
Airtime (Airtime response)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#noise-floor-noisefloor-response" class="md-nav__link">
<span class="md-ellipsis">
Noise Floor (NoiseFloor response)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#stats-stats-response" class="md-nav__link">
<span class="md-ellipsis">
Stats (Stats response)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#battery-battery-response" class="md-nav__link">
<span class="md-ellipsis">
Battery (Battery response)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#mcu-temperature-mcutemp-response" class="md-nav__link">
<span class="md-ellipsis">
MCU Temperature (MCUTemp response)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#device-name-devicename-response" class="md-nav__link">
<span class="md-ellipsis">
Device Name (DeviceName response)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#reboot" class="md-nav__link">
<span class="md-ellipsis">
Reboot
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#sensor-permissions-getsensors" class="md-nav__link">
<span class="md-ellipsis">
Sensor Permissions (GetSensors)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#sensor-data-sensors-response" class="md-nav__link">
<span class="md-ellipsis">
Sensor Data (Sensors response)
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#cryptographic-algorithms" class="md-nav__link">
<span class="md-ellipsis">
Cryptographic Algorithms
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#notes" class="md-nav__link">
<span class="md-ellipsis">
Notes
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../nrf52_power_management/" class="md-nav__link">
<span class="md-ellipsis">
nRF52 Power Management
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../number_allocations/" class="md-nav__link">
<span class="md-ellipsis">
Number Allocations
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../packet_format/" class="md-nav__link">
<span class="md-ellipsis">
Packet Format
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../payloads/" class="md-nav__link">
<span class="md-ellipsis">
Payload Format
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../qr_codes/" class="md-nav__link">
<span class="md-ellipsis">
QR Codes
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../stats_binary_frames/" class="md-nav__link">
<span class="md-ellipsis">
Stats Binary Frame Structures
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../terminal_chat_cli/" class="md-nav__link">
<span class="md-ellipsis">
Terminal Chat CLI
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#serial-configuration" class="md-nav__link">
<span class="md-ellipsis">
Serial Configuration
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#frame-format" class="md-nav__link">
<span class="md-ellipsis">
Frame Format
</span>
</a>
<nav class="md-nav" aria-label="Frame Format">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#type-byte" class="md-nav__link">
<span class="md-ellipsis">
Type Byte
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#standard-kiss-commands" class="md-nav__link">
<span class="md-ellipsis">
Standard KISS Commands
</span>
</a>
<nav class="md-nav" aria-label="Standard KISS Commands">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#host-to-tnc" class="md-nav__link">
<span class="md-ellipsis">
Host to TNC
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#tnc-to-host" class="md-nav__link">
<span class="md-ellipsis">
TNC to Host
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#csma-behavior" class="md-nav__link">
<span class="md-ellipsis">
CSMA Behavior
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#sethardware-extensions-0x06" class="md-nav__link">
<span class="md-ellipsis">
SetHardware Extensions (0x06)
</span>
</a>
<nav class="md-nav" aria-label="SetHardware Extensions (0x06)">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#frame-format_1" class="md-nav__link">
<span class="md-ellipsis">
Frame Format
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#request-sub-commands-host-to-tnc" class="md-nav__link">
<span class="md-ellipsis">
Request Sub-commands (Host to TNC)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#response-sub-commands-tnc-to-host" class="md-nav__link">
<span class="md-ellipsis">
Response Sub-commands (TNC to Host)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#error-codes" class="md-nav__link">
<span class="md-ellipsis">
Error Codes
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#unsolicited-events" class="md-nav__link">
<span class="md-ellipsis">
Unsolicited Events
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#data-formats" class="md-nav__link">
<span class="md-ellipsis">
Data Formats
</span>
</a>
<nav class="md-nav" aria-label="Data Formats">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#radio-parameters-setradio-radio-response" class="md-nav__link">
<span class="md-ellipsis">
Radio Parameters (SetRadio / Radio response)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#version-version-response" class="md-nav__link">
<span class="md-ellipsis">
Version (Version response)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#encrypted-encrypted-response" class="md-nav__link">
<span class="md-ellipsis">
Encrypted (Encrypted response)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#airtime-airtime-response" class="md-nav__link">
<span class="md-ellipsis">
Airtime (Airtime response)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#noise-floor-noisefloor-response" class="md-nav__link">
<span class="md-ellipsis">
Noise Floor (NoiseFloor response)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#stats-stats-response" class="md-nav__link">
<span class="md-ellipsis">
Stats (Stats response)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#battery-battery-response" class="md-nav__link">
<span class="md-ellipsis">
Battery (Battery response)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#mcu-temperature-mcutemp-response" class="md-nav__link">
<span class="md-ellipsis">
MCU Temperature (MCUTemp response)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#device-name-devicename-response" class="md-nav__link">
<span class="md-ellipsis">
Device Name (DeviceName response)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#reboot" class="md-nav__link">
<span class="md-ellipsis">
Reboot
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#sensor-permissions-getsensors" class="md-nav__link">
<span class="md-ellipsis">
Sensor Permissions (GetSensors)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#sensor-data-sensors-response" class="md-nav__link">
<span class="md-ellipsis">
Sensor Data (Sensors response)
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#cryptographic-algorithms" class="md-nav__link">
<span class="md-ellipsis">
Cryptographic Algorithms
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#notes" class="md-nav__link">
<span class="md-ellipsis">
Notes
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<a href="https://github.com/meshcore-dev/meshcore/edit/main/docs/kiss_modem_protocol.md" title="Edit this page" class="md-content__button md-icon" rel="edit">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M10 20H6V4h7v5h5v3.1l2-2V8l-6-6H6c-1.1 0-2 .9-2 2v16c0 1.1.9 2 2 2h4zm10.2-7c.1 0 .3.1.4.2l1.3 1.3c.2.2.2.6 0 .8l-1 1-2.1-2.1 1-1c.1-.1.2-.2.4-.2m0 3.9L14.1 23H12v-2.1l6.1-6.1z"/></svg>
</a>
<h1 id="meshcore-kiss-modem-protocol">MeshCore KISS Modem Protocol</h1>
<p>Standard KISS TNC firmware for MeshCore LoRa radios. Compatible with any KISS client (Direwolf, APRSdroid, YAAC, etc.) for sending and receiving raw packets. MeshCore-specific extensions (cryptography, radio configuration, telemetry) are available through the standard SetHardware (0x06) command.</p>
<h2 id="serial-configuration">Serial Configuration</h2>
<p>115200 baud, 8N1, no flow control.</p>
<h2 id="frame-format">Frame Format</h2>
<p>Standard KISS framing per the KA9Q/K3MC specification.</p>
<table>
<thead>
<tr>
<th>Byte</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>0xC0</code></td>
<td>FEND</td>
<td>Frame delimiter</td>
</tr>
<tr>
<td><code>0xDB</code></td>
<td>FESC</td>
<td>Escape character</td>
</tr>
<tr>
<td><code>0xDC</code></td>
<td>TFEND</td>
<td>Escaped FEND (FESC + TFEND = 0xC0)</td>
</tr>
<tr>
<td><code>0xDD</code></td>
<td>TFESC</td>
<td>Escaped FESC (FESC + TFESC = 0xDB)</td>
</tr>
</tbody>
</table>
<pre><code>┌──────┬───────────┬──────────────┬──────┐
│ FEND │ Type Byte │ Data (escaped)│ FEND │
│ 0xC0 │ 1 byte │ 0-510 bytes │ 0xC0 │
└──────┴───────────┴──────────────┴──────┘
</code></pre>
<h3 id="type-byte">Type Byte</h3>
<p>The type byte is split into two nibbles:</p>
<table>
<thead>
<tr>
<th>Bits</th>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>7-4</td>
<td>Port</td>
<td>Port number (0 for single-port TNC)</td>
</tr>
<tr>
<td>3-0</td>
<td>Command</td>
<td>Command number</td>
</tr>
</tbody>
</table>
<p>Maximum unescaped frame size: 512 bytes.</p>
<h2 id="standard-kiss-commands">Standard KISS Commands</h2>
<h3 id="host-to-tnc">Host to TNC</h3>
<table>
<thead>
<tr>
<th>Command</th>
<th>Value</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>Data</td>
<td><code>0x00</code></td>
<td>Raw packet</td>
<td>Queue packet for transmission</td>
</tr>
<tr>
<td>TXDELAY</td>
<td><code>0x01</code></td>
<td>Delay (1 byte)</td>
<td>Transmitter keyup delay in 10ms units (default: 50 = 500ms)</td>
</tr>
<tr>
<td>Persistence</td>
<td><code>0x02</code></td>
<td>P (1 byte)</td>
<td>CSMA persistence parameter 0-255 (default: 63)</td>
</tr>
<tr>
<td>SlotTime</td>
<td><code>0x03</code></td>
<td>Interval (1 byte)</td>
<td>CSMA slot interval in 10ms units (default: 10 = 100ms)</td>
</tr>
<tr>
<td>TXtail</td>
<td><code>0x04</code></td>
<td>Delay (1 byte)</td>
<td>Post-TX hold time in 10ms units (default: 0)</td>
</tr>
<tr>
<td>FullDuplex</td>
<td><code>0x05</code></td>
<td>Mode (1 byte)</td>
<td>0 = half duplex, nonzero = full duplex (default: 0)</td>
</tr>
<tr>
<td>SetHardware</td>
<td><code>0x06</code></td>
<td>Sub-command + data</td>
<td>MeshCore extensions (see below)</td>
</tr>
<tr>
<td>Return</td>
<td><code>0xFF</code></td>
<td>-</td>
<td>Exit KISS mode (no-op)</td>
</tr>
</tbody>
</table>
<h3 id="tnc-to-host">TNC to Host</h3>
<table>
<thead>
<tr>
<th>Type</th>
<th>Value</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>Data</td>
<td><code>0x00</code></td>
<td>Raw packet</td>
<td>Received packet from radio</td>
</tr>
</tbody>
</table>
<p>Data frames carry raw packet data only, with no metadata prepended. The Data command payload is limited to 255 bytes to match the MeshCore maximum transmission unit (MAX_TRANS_UNIT); frames larger than 255 bytes are silently dropped. The KISS specification recommends at least 1024 bytes for general-purpose TNCs; this modem is intended for MeshCore packets only, whose protocol MTU is 255 bytes.</p>
<h3 id="csma-behavior">CSMA Behavior</h3>
<p>The TNC implements p-persistent CSMA for half-duplex operation:</p>
<ol>
<li>When a packet is queued, monitor carrier detect</li>
<li>When the channel clears, generate a random value 0-255</li>
<li>If the value is less than or equal to P (Persistence), wait TXDELAY then transmit</li>
<li>Otherwise, wait SlotTime and repeat from step 1</li>
</ol>
<p>In full-duplex mode, CSMA is bypassed and packets transmit after TXDELAY.</p>
<h2 id="sethardware-extensions-0x06">SetHardware Extensions (0x06)</h2>
<p>MeshCore-specific functionality uses the standard KISS SetHardware command. The first byte of SetHardware data is a sub-command. Standard KISS clients ignore these frames.</p>
<h3 id="frame-format_1">Frame Format</h3>
<pre><code>┌──────┬──────┬─────────────┬──────────────┬──────┐
│ FEND │ 0x06 │ Sub-command │ Data (escaped)│ FEND │
│ 0xC0 │ │ 1 byte │ variable │ 0xC0 │
└──────┴──────┴─────────────┴──────────────┴──────┘
</code></pre>
<h3 id="request-sub-commands-host-to-tnc">Request Sub-commands (Host to TNC)</h3>
<table>
<thead>
<tr>
<th>Sub-command</th>
<th>Value</th>
<th>Data</th>
</tr>
</thead>
<tbody>
<tr>
<td>GetIdentity</td>
<td><code>0x01</code></td>
<td>-</td>
</tr>
<tr>
<td>GetRandom</td>
<td><code>0x02</code></td>
<td>Length (1 byte, 1-64)</td>
</tr>
<tr>
<td>VerifySignature</td>
<td><code>0x03</code></td>
<td>PubKey (32) + Signature (64) + Data</td>
</tr>
<tr>
<td>SignData</td>
<td><code>0x04</code></td>
<td>Data to sign</td>
</tr>
<tr>
<td>EncryptData</td>
<td><code>0x05</code></td>
<td>Key (32) + Plaintext</td>
</tr>
<tr>
<td>DecryptData</td>
<td><code>0x06</code></td>
<td>Key (32) + MAC (2) + Ciphertext</td>
</tr>
<tr>
<td>KeyExchange</td>
<td><code>0x07</code></td>
<td>Remote PubKey (32)</td>
</tr>
<tr>
<td>Hash</td>
<td><code>0x08</code></td>
<td>Data to hash</td>
</tr>
<tr>
<td>SetRadio</td>
<td><code>0x09</code></td>
<td>Freq (4) + BW (4) + SF (1) + CR (1)</td>
</tr>
<tr>
<td>SetTxPower</td>
<td><code>0x0A</code></td>
<td>Power dBm (1)</td>
</tr>
<tr>
<td>GetRadio</td>
<td><code>0x0B</code></td>
<td>-</td>
</tr>
<tr>
<td>GetTxPower</td>
<td><code>0x0C</code></td>
<td>-</td>
</tr>
<tr>
<td>GetCurrentRssi</td>
<td><code>0x0D</code></td>
<td>-</td>
</tr>
<tr>
<td>IsChannelBusy</td>
<td><code>0x0E</code></td>
<td>-</td>
</tr>
<tr>
<td>GetAirtime</td>
<td><code>0x0F</code></td>
<td>Packet length (1)</td>
</tr>
<tr>
<td>GetNoiseFloor</td>
<td><code>0x10</code></td>
<td>-</td>
</tr>
<tr>
<td>GetVersion</td>
<td><code>0x11</code></td>
<td>-</td>
</tr>
<tr>
<td>GetStats</td>
<td><code>0x12</code></td>
<td>-</td>
</tr>
<tr>
<td>GetBattery</td>
<td><code>0x13</code></td>
<td>-</td>
</tr>
<tr>
<td>GetMCUTemp</td>
<td><code>0x14</code></td>
<td>-</td>
</tr>
<tr>
<td>GetSensors</td>
<td><code>0x15</code></td>
<td>Permissions (1)</td>
</tr>
<tr>
<td>GetDeviceName</td>
<td><code>0x16</code></td>
<td>-</td>
</tr>
<tr>
<td>Ping</td>
<td><code>0x17</code></td>
<td>-</td>
</tr>
<tr>
<td>Reboot</td>
<td><code>0x18</code></td>
<td>-</td>
</tr>
<tr>
<td>SetSignalReport</td>
<td><code>0x19</code></td>
<td>Enable (1): 0x00=disable, nonzero=enable</td>
</tr>
<tr>
<td>GetSignalReport</td>
<td><code>0x1A</code></td>
<td>-</td>
</tr>
</tbody>
</table>
<h3 id="response-sub-commands-tnc-to-host">Response Sub-commands (TNC to Host)</h3>
<p>Response codes use the high-bit convention: <code>response = command | 0x80</code>. Generic and unsolicited responses use the <code>0xF0</code>+ range.</p>
<table>
<thead>
<tr>
<th>Sub-command</th>
<th>Value</th>
<th>Data</th>
</tr>
</thead>
<tbody>
<tr>
<td>Identity</td>
<td><code>0x81</code></td>
<td>PubKey (32)</td>
</tr>
<tr>
<td>Random</td>
<td><code>0x82</code></td>
<td>Random bytes (1-64)</td>
</tr>
<tr>
<td>Verify</td>
<td><code>0x83</code></td>
<td>Result (1): 0x00=invalid, 0x01=valid</td>
</tr>
<tr>
<td>Signature</td>
<td><code>0x84</code></td>
<td>Signature (64)</td>
</tr>
<tr>
<td>Encrypted</td>
<td><code>0x85</code></td>
<td>MAC (2) + Ciphertext</td>
</tr>
<tr>
<td>Decrypted</td>
<td><code>0x86</code></td>
<td>Plaintext</td>
</tr>
<tr>
<td>SharedSecret</td>
<td><code>0x87</code></td>
<td>Shared secret (32)</td>
</tr>
<tr>
<td>Hash</td>
<td><code>0x88</code></td>
<td>SHA-256 hash (32)</td>
</tr>
<tr>
<td>Radio</td>
<td><code>0x8B</code></td>
<td>Freq (4) + BW (4) + SF (1) + CR (1)</td>
</tr>
<tr>
<td>TxPower</td>
<td><code>0x8C</code></td>
<td>Power dBm (1)</td>
</tr>
<tr>
<td>CurrentRssi</td>
<td><code>0x8D</code></td>
<td>RSSI dBm (1, signed)</td>
</tr>
<tr>
<td>ChannelBusy</td>
<td><code>0x8E</code></td>
<td>Result (1): 0x00=clear, 0x01=busy</td>
</tr>
<tr>
<td>Airtime</td>
<td><code>0x8F</code></td>
<td>Milliseconds (4)</td>
</tr>
<tr>
<td>NoiseFloor</td>
<td><code>0x90</code></td>
<td>dBm (2, signed)</td>
</tr>
<tr>
<td>Version</td>
<td><code>0x91</code></td>
<td>Version (1) + Reserved (1)</td>
</tr>
<tr>
<td>Stats</td>
<td><code>0x92</code></td>
<td>RX (4) + TX (4) + Errors (4)</td>
</tr>
<tr>
<td>Battery</td>
<td><code>0x93</code></td>
<td>Millivolts (2)</td>
</tr>
<tr>
<td>MCUTemp</td>
<td><code>0x94</code></td>
<td>Temperature (2, signed)</td>
</tr>
<tr>
<td>Sensors</td>
<td><code>0x95</code></td>
<td>CayenneLPP payload</td>
</tr>
<tr>
<td>DeviceName</td>
<td><code>0x96</code></td>
<td>Name (variable, UTF-8)</td>
</tr>
<tr>
<td>Pong</td>
<td><code>0x97</code></td>
<td>-</td>
</tr>
<tr>
<td>SignalReport</td>
<td><code>0x9A</code></td>
<td>Status (1): 0x00=disabled, 0x01=enabled</td>
</tr>
<tr>
<td>OK</td>
<td><code>0xF0</code></td>
<td>-</td>
</tr>
<tr>
<td>Error</td>
<td><code>0xF1</code></td>
<td>Error code (1)</td>
</tr>
<tr>
<td>TxDone</td>
<td><code>0xF8</code></td>
<td>Result (1): 0x00=failed, 0x01=success</td>
</tr>
<tr>
<td>RxMeta</td>
<td><code>0xF9</code></td>
<td>SNR (1) + RSSI (1)</td>
</tr>
</tbody>
</table>
<h3 id="error-codes">Error Codes</h3>
<table>
<thead>
<tr>
<th>Code</th>
<th>Value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>InvalidLength</td>
<td><code>0x01</code></td>
<td>Request data too short</td>
</tr>
<tr>
<td>InvalidParam</td>
<td><code>0x02</code></td>
<td>Invalid parameter value</td>
</tr>
<tr>
<td>NoCallback</td>
<td><code>0x03</code></td>
<td>Feature not available</td>
</tr>
<tr>
<td>MacFailed</td>
<td><code>0x04</code></td>
<td>MAC verification failed</td>
</tr>
<tr>
<td>UnknownCmd</td>
<td><code>0x05</code></td>
<td>Unknown sub-command</td>
</tr>
<tr>
<td>EncryptFailed</td>
<td><code>0x06</code></td>
<td>Encryption failed</td>
</tr>
</tbody>
</table>
<h3 id="unsolicited-events">Unsolicited Events</h3>
<p>The TNC sends these SetHardware frames without a preceding request:</p>
<p><strong>TxDone (0xF8)</strong>: Sent after a packet has been transmitted. Contains a single byte: 0x01 for success, 0x00 for failure.</p>
<p><strong>RxMeta (0xF9)</strong>: Sent immediately after each standard data frame (type 0x00) with metadata for the received packet. Contains SNR (1 byte, signed, value x4 for 0.25 dB precision) followed by RSSI (1 byte, signed, dBm). Enabled by default; can be toggled with SetSignalReport. Standard KISS clients ignore this frame.</p>
<h2 id="data-formats">Data Formats</h2>
<h3 id="radio-parameters-setradio-radio-response">Radio Parameters (SetRadio / Radio response)</h3>
<p>All values little-endian.</p>
<table>
<thead>
<tr>
<th>Field</th>
<th>Size</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>Frequency</td>
<td>4 bytes</td>
<td>Hz (e.g., 869618000)</td>
</tr>
<tr>
<td>Bandwidth</td>
<td>4 bytes</td>
<td>Hz (e.g., 62500)</td>
</tr>
<tr>
<td>SF</td>
<td>1 byte</td>
<td>Spreading factor (5-12)</td>
</tr>
<tr>
<td>CR</td>
<td>1 byte</td>
<td>Coding rate (5-8)</td>
</tr>
</tbody>
</table>
<h3 id="version-version-response">Version (Version response)</h3>
<table>
<thead>
<tr>
<th>Field</th>
<th>Size</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>Version</td>
<td>1 byte</td>
<td>Firmware version</td>
</tr>
<tr>
<td>Reserved</td>
<td>1 byte</td>
<td>Always 0</td>
</tr>
</tbody>
</table>
<h3 id="encrypted-encrypted-response">Encrypted (Encrypted response)</h3>
<table>
<thead>
<tr>
<th>Field</th>
<th>Size</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>MAC</td>
<td>2 bytes</td>
<td>HMAC-SHA256 truncated to 2 bytes</td>
</tr>
<tr>
<td>Ciphertext</td>
<td>variable</td>
<td>AES-128 block-encrypted data with zero padding</td>
</tr>
</tbody>
</table>
<h3 id="airtime-airtime-response">Airtime (Airtime response)</h3>
<p>All values little-endian.</p>
<table>
<thead>
<tr>
<th>Field</th>
<th>Size</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>Airtime</td>
<td>4 bytes</td>
<td>uint32_t, estimated air time in milliseconds</td>
</tr>
</tbody>
</table>
<h3 id="noise-floor-noisefloor-response">Noise Floor (NoiseFloor response)</h3>
<p>All values little-endian.</p>
<table>
<thead>
<tr>
<th>Field</th>
<th>Size</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>Noise floor</td>
<td>2 bytes</td>
<td>int16_t, dBm (signed)</td>
</tr>
</tbody>
</table>
<p>The modem recalibrates the noise floor every 2 seconds with an AGC reset every 30 seconds.</p>
<h3 id="stats-stats-response">Stats (Stats response)</h3>
<p>All values little-endian.</p>
<table>
<thead>
<tr>
<th>Field</th>
<th>Size</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>RX</td>
<td>4 bytes</td>
<td>Packets received</td>
</tr>
<tr>
<td>TX</td>
<td>4 bytes</td>
<td>Packets transmitted</td>
</tr>
<tr>
<td>Errors</td>
<td>4 bytes</td>
<td>Receive errors</td>
</tr>
</tbody>
</table>
<h3 id="battery-battery-response">Battery (Battery response)</h3>
<p>All values little-endian.</p>
<table>
<thead>
<tr>
<th>Field</th>
<th>Size</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>Millivolts</td>
<td>2 bytes</td>
<td>uint16_t, battery voltage in mV</td>
</tr>
</tbody>
</table>
<h3 id="mcu-temperature-mcutemp-response">MCU Temperature (MCUTemp response)</h3>
<p>All values little-endian.</p>
<table>
<thead>
<tr>
<th>Field</th>
<th>Size</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>Temperature</td>
<td>2 bytes</td>
<td>int16_t, tenths of °C (e.g., 253 = 25.3°C)</td>
</tr>
</tbody>
</table>
<p>Returns <code>NoCallback</code> error if the board does not support temperature readings.</p>
<h3 id="device-name-devicename-response">Device Name (DeviceName response)</h3>
<table>
<thead>
<tr>
<th>Field</th>
<th>Size</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>Name</td>
<td>variable</td>
<td>UTF-8 string, no null terminator</td>
</tr>
</tbody>
</table>
<h3 id="reboot">Reboot</h3>
<p>Sends an <code>OK</code> response, flushes serial, then reboots the device. The host should expect the connection to drop.</p>
<h3 id="sensor-permissions-getsensors">Sensor Permissions (GetSensors)</h3>
<table>
<thead>
<tr>
<th>Bit</th>
<th>Value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>0</td>
<td><code>0x01</code></td>
<td>Base (battery)</td>
</tr>
<tr>
<td>1</td>
<td><code>0x02</code></td>
<td>Location (GPS)</td>
</tr>
<tr>
<td>2</td>
<td><code>0x04</code></td>
<td>Environment (temp, humidity, pressure)</td>
</tr>
</tbody>
</table>
<p>Use <code>0x07</code> for all permissions.</p>
<h3 id="sensor-data-sensors-response">Sensor Data (Sensors response)</h3>
<p>Data returned in CayenneLPP format. See <a href="https://docs.mydevices.com/docs/lorawan/cayenne-lpp">CayenneLPP documentation</a> for parsing.</p>
<h2 id="cryptographic-algorithms">Cryptographic Algorithms</h2>
<table>
<thead>
<tr>
<th>Operation</th>
<th>Algorithm</th>
</tr>
</thead>
<tbody>
<tr>
<td>Identity / Signing / Verification</td>
<td>Ed25519</td>
</tr>
<tr>
<td>Key Exchange</td>
<td>X25519 (ECDH)</td>
</tr>
<tr>
<td>Encryption</td>
<td>AES-128 block encryption with zero padding + HMAC-SHA256 (MAC truncated to 2 bytes)</td>
</tr>
<tr>
<td>Hashing</td>
<td>SHA-256</td>
</tr>
</tbody>
</table>
<h2 id="notes">Notes</h2>
<ul>
<li>Data payload limit (255 bytes) matches MeshCore MAX_TRANS_UNIT; no change needed for KISS “1024+ recommended” (that applies to general TNCs, not MeshCore)</li>
<li>Modem generates identity on first boot (stored in flash)</li>
<li>All multi-byte values are little-endian unless stated otherwise</li>
<li>SNR values in RxMeta are multiplied by 4 for 0.25 dB precision</li>
<li>TxDone is sent as a SetHardware event after each transmission</li>
<li>Standard KISS clients receive only type 0x00 data frames and can safely ignore all SetHardware (0x06) frames</li>
<li>See <a href="../packet_format/">packet_format.md</a> for packet format</li>
</ul>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"annotate": null, "base": "..", "features": ["content.action.edit", "content.code.copy", "search.highlight", "search.suggest"], "search": "../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
<script src="../assets/javascripts/bundle.79ae519e.min.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink