diff --git a/README.md b/README.md index 59e150b51d1adad46138a19e54f2acf5ae704a45..c2654b175e4591dc67cbc4fb62de8e8f7815cf24 100644 --- a/README.md +++ b/README.md @@ -266,6 +266,7 @@ I only started messing around with Meshtastic last week *(as of time of this wri - [getConfig](#getconfig) - [getMetadata](#getmetadata) - [getModuleConfig](#getmoduleconfig) +- [getNodeInfo](#getnodeinfo) - [getOwner](#getowner) - [listenerCount](#listenercount) - [listeners](#listeners) @@ -280,7 +281,6 @@ I only started messing around with Meshtastic last week *(as of time of this wri - [removeListener](#removelistener) - [resetNodes](#resetnodes) - [sendAdminMessage](#sendadminmessage) -- [sendEncrypted](#sendencrypted) - [sendHeartbeat](#sendheartbeat) - [sendPacket](#sendpacket) - [sendText](#sendtext) @@ -319,7 +319,7 @@ js.global.EventEmitter.constructor ###### Defined in -src/lib/device.ts:44 +src/lib/device.ts:45 #### Properties @@ -381,7 +381,7 @@ Device type and connection details for log messages ###### Defined in -src/lib/device.ts:61 +src/lib/device.ts:63 ___ @@ -449,7 +449,7 @@ This will forestall the reboot until you're ready to bulk-commit your changes. ###### Defined in -src/lib/device.ts:410 +src/lib/device.ts:368 ___ @@ -463,7 +463,7 @@ ___ ###### Defined in -src/lib/device.ts:560 +src/lib/device.ts:518 ___ @@ -477,7 +477,7 @@ ___ ###### Defined in -src/lib/device.ts:546 +src/lib/device.ts:504 ___ @@ -493,7 +493,7 @@ The companion method to `beginEditSettings`. Call this when you're ready to comm ###### Defined in -src/lib/device.ts:421 +src/lib/device.ts:379 ___ @@ -513,7 +513,7 @@ ___ ###### Defined in -src/lib/device.ts:62 +src/lib/device.ts:64 ___ @@ -531,7 +531,7 @@ and perform maintenance. ###### Defined in -src/lib/device.ts:118 +src/lib/device.ts:120 ___ @@ -545,7 +545,7 @@ ___ ###### Defined in -src/lib/device.ts:63 +src/lib/device.ts:65 ___ @@ -606,7 +606,7 @@ Maybe we want to ensure factory defaults before applying common settings to any ###### Defined in -src/lib/device.ts:605 +src/lib/device.ts:563 ___ @@ -627,7 +627,7 @@ ___ ###### Defined in -src/lib/device.ts:476 +src/lib/device.ts:434 ___ @@ -648,7 +648,7 @@ ___ ###### Defined in -src/lib/device.ts:486 +src/lib/device.ts:444 ___ @@ -669,7 +669,7 @@ ___ ###### Defined in -src/lib/device.ts:516 +src/lib/device.ts:474 ___ @@ -690,7 +690,29 @@ ___ ###### Defined in -src/lib/device.ts:496 +src/lib/device.ts:454 + +___ + +##### getNodeInfo + +▸ **getNodeInfo**(`nodeNum`): `undefined` \| `NodeInfo` + +Return data about the given node number from our node DB, or undefined if we don't got none. + +###### Parameters + +| Name | Type | +| :------ | :------ | +| `nodeNum` | `number` | + +###### Returns + +`undefined` \| `NodeInfo` + +###### Defined in + +src/lib/device.ts:585 ___ @@ -710,7 +732,7 @@ ___ ###### Defined in -src/lib/device.ts:506 +src/lib/device.ts:464 ___ @@ -880,7 +902,7 @@ Any associated event listeners (callbacks), ack or response handlers will be cal ###### Defined in -src/lib/device.ts:248 +src/lib/device.ts:250 ___ @@ -900,7 +922,7 @@ ___ ###### Defined in -src/lib/device.ts:550 +src/lib/device.ts:508 ___ @@ -938,7 +960,7 @@ ___ ###### Defined in -src/lib/device.ts:590 +src/lib/device.ts:548 ___ @@ -977,7 +999,7 @@ ___ ###### Defined in -src/lib/device.ts:526 +src/lib/device.ts:484 ___ @@ -1001,32 +1023,7 @@ Send an [AdminMessage](https://buf.build/meshtastic/protobufs/docs/main:meshtast ###### Defined in -src/lib/device.ts:395 - -___ - -##### sendEncrypted - -▸ **sendEncrypted**(`«destructured»`): `boolean` - -Assembles a [MeshPacket](https://buf.build/meshtastic/protobufs/docs/main:meshtastic#meshtastic.MeshPacket) with an encrypted payload. -To do: -Currently you would have to encrypt 'payload' yourself prior to calling. -Presumably we could use channel info read upon initialization to get psk (and alg?) and encrypt 'payload' within this method - -###### Parameters - -| Name | Type | -| :------ | :------ | -| `«destructured»` | [`IEncryptedMeshPacketParams`](#interfacesdefsiencryptedmeshpacketparamsmd) | - -###### Returns - -`boolean` - -###### Defined in - -src/lib/device.ts:276 +src/lib/device.ts:353 ___ @@ -1042,7 +1039,7 @@ You probably don't need to call this directly. It's only really needed for Seria ###### Defined in -src/lib/device.ts:616 +src/lib/device.ts:574 ___ @@ -1064,7 +1061,7 @@ Assembles a [MeshPacket](https://buf.build/meshtastic/protobufs/docs/main:meshta ###### Defined in -src/lib/device.ts:315 +src/lib/device.ts:273 ___ @@ -1086,7 +1083,7 @@ Send a text message out into the mesh, optionally specifying a 'to' node address ###### Defined in -src/lib/device.ts:374 +src/lib/device.ts:332 ___ @@ -1106,7 +1103,7 @@ ___ ###### Defined in -src/lib/device.ts:461 +src/lib/device.ts:419 ___ @@ -1126,7 +1123,7 @@ ___ ###### Defined in -src/lib/device.ts:431 +src/lib/device.ts:389 ___ @@ -1146,7 +1143,7 @@ ___ ###### Defined in -src/lib/device.ts:580 +src/lib/device.ts:538 ___ @@ -1169,7 +1166,7 @@ ___ ###### Defined in -src/lib/device.ts:564 +src/lib/device.ts:522 ___ @@ -1189,7 +1186,7 @@ ___ ###### Defined in -src/lib/device.ts:441 +src/lib/device.ts:399 ___ @@ -1209,7 +1206,7 @@ ___ ###### Defined in -src/lib/device.ts:451 +src/lib/device.ts:409 ___ @@ -1229,7 +1226,7 @@ ___ ###### Defined in -src/lib/device.ts:471 +src/lib/device.ts:429 ___ @@ -1249,7 +1246,7 @@ ___ ###### Defined in -src/lib/device.ts:536 +src/lib/device.ts:494 ___ @@ -1271,7 +1268,7 @@ Write a [ToRadio](https://buf.build/meshtastic/protobufs/docs/main:meshtastic#me ###### Defined in -src/lib/device.ts:261 +src/lib/device.ts:263 <a name="classesserialdevicemd"></a> @@ -1320,6 +1317,7 @@ src/lib/device.ts:261 - [getConfig](#getconfig) - [getMetadata](#getmetadata) - [getModuleConfig](#getmoduleconfig) +- [getNodeInfo](#getnodeinfo) - [getOwner](#getowner) - [listenerCount](#listenercount) - [listeners](#listeners) @@ -1334,7 +1332,6 @@ src/lib/device.ts:261 - [removeListener](#removelistener) - [resetNodes](#resetnodes) - [sendAdminMessage](#sendadminmessage) -- [sendEncrypted](#sendencrypted) - [sendHeartbeat](#sendheartbeat) - [sendPacket](#sendpacket) - [sendText](#sendtext) @@ -1551,7 +1548,7 @@ This will forestall the reboot until you're ready to bulk-commit your changes. ###### Defined in -src/lib/device.ts:410 +src/lib/device.ts:368 ___ @@ -1569,7 +1566,7 @@ ___ ###### Defined in -src/lib/device.ts:560 +src/lib/device.ts:518 ___ @@ -1587,7 +1584,7 @@ ___ ###### Defined in -src/lib/device.ts:546 +src/lib/device.ts:504 ___ @@ -1607,7 +1604,7 @@ The companion method to `beginEditSettings`. Call this when you're ready to comm ###### Defined in -src/lib/device.ts:421 +src/lib/device.ts:379 ___ @@ -1655,7 +1652,7 @@ and perform maintenance. ###### Defined in -src/lib/device.ts:118 +src/lib/device.ts:120 ___ @@ -1740,7 +1737,7 @@ Maybe we want to ensure factory defaults before applying common settings to any ###### Defined in -src/lib/device.ts:605 +src/lib/device.ts:563 ___ @@ -1765,7 +1762,7 @@ ___ ###### Defined in -src/lib/device.ts:476 +src/lib/device.ts:434 ___ @@ -1790,7 +1787,7 @@ ___ ###### Defined in -src/lib/device.ts:486 +src/lib/device.ts:444 ___ @@ -1815,7 +1812,7 @@ ___ ###### Defined in -src/lib/device.ts:516 +src/lib/device.ts:474 ___ @@ -1840,7 +1837,33 @@ ___ ###### Defined in -src/lib/device.ts:496 +src/lib/device.ts:454 + +___ + +##### getNodeInfo + +▸ **getNodeInfo**(`nodeNum`): `undefined` \| `NodeInfo` + +Return data about the given node number from our node DB, or undefined if we don't got none. + +###### Parameters + +| Name | Type | +| :------ | :------ | +| `nodeNum` | `number` | + +###### Returns + +`undefined` \| `NodeInfo` + +###### Inherited from + +[Device](#classesdevicemd).[getNodeInfo](#getnodeinfo) + +###### Defined in + +src/lib/device.ts:585 ___ @@ -1864,7 +1887,7 @@ ___ ###### Defined in -src/lib/device.ts:506 +src/lib/device.ts:464 ___ @@ -2038,7 +2061,7 @@ Any associated event listeners (callbacks), ack or response handlers will be cal ###### Defined in -src/lib/device.ts:248 +src/lib/device.ts:250 ___ @@ -2062,7 +2085,7 @@ ___ ###### Defined in -src/lib/device.ts:550 +src/lib/device.ts:508 ___ @@ -2104,7 +2127,7 @@ ___ ###### Defined in -src/lib/device.ts:590 +src/lib/device.ts:548 ___ @@ -2147,7 +2170,7 @@ ___ ###### Defined in -src/lib/device.ts:526 +src/lib/device.ts:484 ___ @@ -2175,36 +2198,7 @@ Send an [AdminMessage](https://buf.build/meshtastic/protobufs/docs/main:meshtast ###### Defined in -src/lib/device.ts:395 - -___ - -##### sendEncrypted - -▸ **sendEncrypted**(`«destructured»`): `boolean` - -Assembles a [MeshPacket](https://buf.build/meshtastic/protobufs/docs/main:meshtastic#meshtastic.MeshPacket) with an encrypted payload. -To do: -Currently you would have to encrypt 'payload' yourself prior to calling. -Presumably we could use channel info read upon initialization to get psk (and alg?) and encrypt 'payload' within this method - -###### Parameters - -| Name | Type | -| :------ | :------ | -| `«destructured»` | [`IEncryptedMeshPacketParams`](#interfacesdefsiencryptedmeshpacketparamsmd) | - -###### Returns - -`boolean` - -###### Inherited from - -[Device](#classesdevicemd).[sendEncrypted](#sendencrypted) - -###### Defined in - -src/lib/device.ts:276 +src/lib/device.ts:353 ___ @@ -2224,7 +2218,7 @@ You probably don't need to call this directly. It's only really needed for Seria ###### Defined in -src/lib/device.ts:616 +src/lib/device.ts:574 ___ @@ -2250,7 +2244,7 @@ Assembles a [MeshPacket](https://buf.build/meshtastic/protobufs/docs/main:meshta ###### Defined in -src/lib/device.ts:315 +src/lib/device.ts:273 ___ @@ -2276,7 +2270,7 @@ Send a text message out into the mesh, optionally specifying a 'to' node address ###### Defined in -src/lib/device.ts:374 +src/lib/device.ts:332 ___ @@ -2300,7 +2294,7 @@ ___ ###### Defined in -src/lib/device.ts:461 +src/lib/device.ts:419 ___ @@ -2324,7 +2318,7 @@ ___ ###### Defined in -src/lib/device.ts:431 +src/lib/device.ts:389 ___ @@ -2348,7 +2342,7 @@ ___ ###### Defined in -src/lib/device.ts:580 +src/lib/device.ts:538 ___ @@ -2375,7 +2369,7 @@ ___ ###### Defined in -src/lib/device.ts:564 +src/lib/device.ts:522 ___ @@ -2399,7 +2393,7 @@ ___ ###### Defined in -src/lib/device.ts:441 +src/lib/device.ts:399 ___ @@ -2423,7 +2417,7 @@ ___ ###### Defined in -src/lib/device.ts:451 +src/lib/device.ts:409 ___ @@ -2447,7 +2441,7 @@ ___ ###### Defined in -src/lib/device.ts:471 +src/lib/device.ts:429 ___ @@ -2471,7 +2465,7 @@ ___ ###### Defined in -src/lib/device.ts:536 +src/lib/device.ts:494 ___ @@ -2497,7 +2491,7 @@ Write a [ToRadio](https://buf.build/meshtastic/protobufs/docs/main:meshtastic#me ###### Defined in -src/lib/device.ts:261 +src/lib/device.ts:263 <a name="classessocketdevicemd"></a> @@ -2548,6 +2542,7 @@ src/lib/device.ts:261 - [getConfig](#getconfig) - [getMetadata](#getmetadata) - [getModuleConfig](#getmoduleconfig) +- [getNodeInfo](#getnodeinfo) - [getOwner](#getowner) - [listenerCount](#listenercount) - [listeners](#listeners) @@ -2562,7 +2557,6 @@ src/lib/device.ts:261 - [removeListener](#removelistener) - [resetNodes](#resetnodes) - [sendAdminMessage](#sendadminmessage) -- [sendEncrypted](#sendencrypted) - [sendHeartbeat](#sendheartbeat) - [sendPacket](#sendpacket) - [sendText](#sendtext) @@ -2801,7 +2795,7 @@ This will forestall the reboot until you're ready to bulk-commit your changes. ###### Defined in -src/lib/device.ts:410 +src/lib/device.ts:368 ___ @@ -2819,7 +2813,7 @@ ___ ###### Defined in -src/lib/device.ts:560 +src/lib/device.ts:518 ___ @@ -2837,7 +2831,7 @@ ___ ###### Defined in -src/lib/device.ts:546 +src/lib/device.ts:504 ___ @@ -2857,7 +2851,7 @@ The companion method to `beginEditSettings`. Call this when you're ready to comm ###### Defined in -src/lib/device.ts:421 +src/lib/device.ts:379 ___ @@ -2905,7 +2899,7 @@ and perform maintenance. ###### Defined in -src/lib/device.ts:118 +src/lib/device.ts:120 ___ @@ -2990,7 +2984,7 @@ Maybe we want to ensure factory defaults before applying common settings to any ###### Defined in -src/lib/device.ts:605 +src/lib/device.ts:563 ___ @@ -3015,7 +3009,7 @@ ___ ###### Defined in -src/lib/device.ts:476 +src/lib/device.ts:434 ___ @@ -3040,7 +3034,7 @@ ___ ###### Defined in -src/lib/device.ts:486 +src/lib/device.ts:444 ___ @@ -3065,7 +3059,7 @@ ___ ###### Defined in -src/lib/device.ts:516 +src/lib/device.ts:474 ___ @@ -3090,7 +3084,33 @@ ___ ###### Defined in -src/lib/device.ts:496 +src/lib/device.ts:454 + +___ + +##### getNodeInfo + +▸ **getNodeInfo**(`nodeNum`): `undefined` \| `NodeInfo` + +Return data about the given node number from our node DB, or undefined if we don't got none. + +###### Parameters + +| Name | Type | +| :------ | :------ | +| `nodeNum` | `number` | + +###### Returns + +`undefined` \| `NodeInfo` + +###### Inherited from + +[Device](#classesdevicemd).[getNodeInfo](#getnodeinfo) + +###### Defined in + +src/lib/device.ts:585 ___ @@ -3114,7 +3134,7 @@ ___ ###### Defined in -src/lib/device.ts:506 +src/lib/device.ts:464 ___ @@ -3288,7 +3308,7 @@ Any associated event listeners (callbacks), ack or response handlers will be cal ###### Defined in -src/lib/device.ts:248 +src/lib/device.ts:250 ___ @@ -3312,7 +3332,7 @@ ___ ###### Defined in -src/lib/device.ts:550 +src/lib/device.ts:508 ___ @@ -3354,7 +3374,7 @@ ___ ###### Defined in -src/lib/device.ts:590 +src/lib/device.ts:548 ___ @@ -3397,7 +3417,7 @@ ___ ###### Defined in -src/lib/device.ts:526 +src/lib/device.ts:484 ___ @@ -3425,36 +3445,7 @@ Send an [AdminMessage](https://buf.build/meshtastic/protobufs/docs/main:meshtast ###### Defined in -src/lib/device.ts:395 - -___ - -##### sendEncrypted - -▸ **sendEncrypted**(`«destructured»`): `boolean` - -Assembles a [MeshPacket](https://buf.build/meshtastic/protobufs/docs/main:meshtastic#meshtastic.MeshPacket) with an encrypted payload. -To do: -Currently you would have to encrypt 'payload' yourself prior to calling. -Presumably we could use channel info read upon initialization to get psk (and alg?) and encrypt 'payload' within this method - -###### Parameters - -| Name | Type | -| :------ | :------ | -| `«destructured»` | [`IEncryptedMeshPacketParams`](#interfacesdefsiencryptedmeshpacketparamsmd) | - -###### Returns - -`boolean` - -###### Inherited from - -[Device](#classesdevicemd).[sendEncrypted](#sendencrypted) - -###### Defined in - -src/lib/device.ts:276 +src/lib/device.ts:353 ___ @@ -3474,7 +3465,7 @@ You probably don't need to call this directly. It's only really needed for Seria ###### Defined in -src/lib/device.ts:616 +src/lib/device.ts:574 ___ @@ -3500,7 +3491,7 @@ Assembles a [MeshPacket](https://buf.build/meshtastic/protobufs/docs/main:meshta ###### Defined in -src/lib/device.ts:315 +src/lib/device.ts:273 ___ @@ -3526,7 +3517,7 @@ Send a text message out into the mesh, optionally specifying a 'to' node address ###### Defined in -src/lib/device.ts:374 +src/lib/device.ts:332 ___ @@ -3550,7 +3541,7 @@ ___ ###### Defined in -src/lib/device.ts:461 +src/lib/device.ts:419 ___ @@ -3574,7 +3565,7 @@ ___ ###### Defined in -src/lib/device.ts:431 +src/lib/device.ts:389 ___ @@ -3598,7 +3589,7 @@ ___ ###### Defined in -src/lib/device.ts:580 +src/lib/device.ts:538 ___ @@ -3625,7 +3616,7 @@ ___ ###### Defined in -src/lib/device.ts:564 +src/lib/device.ts:522 ___ @@ -3649,7 +3640,7 @@ ___ ###### Defined in -src/lib/device.ts:441 +src/lib/device.ts:399 ___ @@ -3673,7 +3664,7 @@ ___ ###### Defined in -src/lib/device.ts:451 +src/lib/device.ts:409 ___ @@ -3697,7 +3688,7 @@ ___ ###### Defined in -src/lib/device.ts:471 +src/lib/device.ts:429 ___ @@ -3721,7 +3712,7 @@ ___ ###### Defined in -src/lib/device.ts:536 +src/lib/device.ts:494 ___ @@ -3747,7 +3738,7 @@ Write a [ToRadio](https://buf.build/meshtastic/protobufs/docs/main:meshtastic#me ###### Defined in -src/lib/device.ts:261 +src/lib/device.ts:263 ## Enums