node-mavlink 1.4.0 → 1.4.1

package/README.md

@@ -226,6 +226,16 @@ The default values for some parameters are as follows:
 
 This is a very handy utility function that asynchronously pauses for a given time (ms).
 
+## Running sim_vehicle.py
+
+The easiest way to start playing around with this package is to use `sim_vehicle.py`. You can use the default parameters forthe MavEsp8266 if you'll make the simulator compatible with it:
+
+```
+$ Tools/autotest/sim_vehicle.py -v ArduCopter -f quad --console --map --out udpin:127.0.0.1:14555
+```
+
+That last parameter (`--out udpin:127.0.0.1:14555`) opens up for incoming messages in port 14555, which is the default send port for MavEsp8266 and its default firmware.
+
 ## Closing thoughts
 
 The original generated sources lack one very important aspect of a reusable library: documentation. Also, most of the time the names are more C-like than JavaScript-like.

package/examples/send-receive-udp.ts

@@ -9,13 +9,19 @@ const REGISTRY: MavLinkPacketRegistry = {
   ...ardupilotmega.REGISTRY,
 }
 
+// This is how you could build a registry of all commands from different packages
+const COMMANDS: common.MavLinkCommandRegistry = {
+  ...common.COMMANDS,
+  ...ardupilotmega.COMMANDS,
+}
+
 async function main() {
   const port = new MavEsp8266()
 
   // start the communication
   // After this line we have received at least one heartbeat message so we
   // know what is the remote IP address to send the messages to
-  const { ip, sendPort, receivePort } = await port.start()
+  const { ip, sendPort, receivePort } = await port.start(14551)
   console.log(`Connected to: ${ip}, send port: ${sendPort}, receive port ${receivePort}`)
 
   // log incomming messages
@@ -33,21 +39,18 @@ async function main() {
 
   // You're now ready to send messages to the controller using the socket
   // let's request the list of parameters
+  const cmdSetMode = new common.DoSetModeCommand()
+  cmdSetMode.mode = 1
+  cmdSetMode.customMode = ardupilotmega.CopterMode.DRIFT
 
-  const cmdParamList = new common.ParamRequestList()
-  cmdParamList.targetSystem = 1
-  cmdParamList.targetComponent = 1
-
-  // The send method is another utility method, very handy to have it provided
-  // by the library. It takes care of the sequence number and data serialization.
-  await port.send(cmdParamList)
+  await port.send(cmdSetMode)
 
-  // Here's another example of sending commands
-  const cmdSetRelay = new common.DoSetRelayCommand()
-  cmdSetRelay.instance = 0
-  cmdSetRelay.setting = 1
+  // Give the system time to process any incoming acknowledges
+  const sleep = (ms: number) => new Promise(resolve => setTimeout(resolve, ms))
+  await sleep(1000)
 
-  await port.send(cmdSetRelay)
+  // Close communication
+  port.close()
 }
 
 main()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-mavlink",
-  "version": "1.4.0",
+  "version": "1.4.1",
   "author": "Matthias Hryniszak <padcom@gmail.com>",
   "license": "LGPL",
   "description": "MavLink definitions and parsing library",
@@ -22,7 +22,7 @@
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "dependencies": {
-    "mavlink-mappings": "^1.0.13-20230115"
+    "mavlink-mappings": "^1.0.13-20230115-3"
   },
   "scripts": {
     "clean": "rm -rf dist lib/*.js",