Compare commits
11 Commits
f600aa98e7
...
f59bc9931e
| Author | SHA1 | Date | |
|---|---|---|---|
| f59bc9931e | |||
| d235c414e0 | |||
| 62d7525df7 | |||
| 2b3f3584a9 | |||
| 7a100b2d14 | |||
| 37b646780d | |||
| 2d60aab79c | |||
| af982bb575 | |||
| 6d59baa30e | |||
| 1ec4d3fc58 | |||
|
|
c6cf64217d |
46
android/build.gradle
Normal file
46
android/build.gradle
Normal file
@ -0,0 +1,46 @@
|
||||
plugins {
|
||||
id 'com.android.application'
|
||||
id 'kotlin-android'
|
||||
}
|
||||
|
||||
android {
|
||||
compileSdk 34
|
||||
namespace 'com.saltylab.uwbtag'
|
||||
|
||||
defaultConfig {
|
||||
applicationId "com.saltylab.uwbtag"
|
||||
minSdk 26
|
||||
targetSdk 34
|
||||
versionCode 1
|
||||
versionName "1.0"
|
||||
}
|
||||
|
||||
buildTypes {
|
||||
release {
|
||||
minifyEnabled false
|
||||
}
|
||||
}
|
||||
|
||||
buildFeatures {
|
||||
viewBinding true
|
||||
}
|
||||
|
||||
compileOptions {
|
||||
sourceCompatibility JavaVersion.VERSION_17
|
||||
targetCompatibility JavaVersion.VERSION_17
|
||||
}
|
||||
|
||||
kotlinOptions {
|
||||
jvmTarget = '17'
|
||||
}
|
||||
}
|
||||
|
||||
dependencies {
|
||||
implementation 'androidx.core:core-ktx:1.12.0'
|
||||
implementation 'androidx.appcompat:appcompat:1.6.1'
|
||||
implementation 'com.google.android.material:material:1.11.0'
|
||||
implementation 'androidx.recyclerview:recyclerview:1.3.2'
|
||||
implementation 'androidx.lifecycle:lifecycle-runtime-ktx:2.7.0'
|
||||
implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.7.3'
|
||||
implementation 'com.google.code.gson:gson:2.10.1'
|
||||
}
|
||||
37
android/src/main/AndroidManifest.xml
Normal file
37
android/src/main/AndroidManifest.xml
Normal file
@ -0,0 +1,37 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<manifest xmlns:android="http://schemas.android.com/apk/res/android">
|
||||
|
||||
<!-- BLE permissions (API 31+) -->
|
||||
<uses-permission android:name="android.permission.BLUETOOTH_SCAN"
|
||||
android:usesPermissionFlags="neverForLocation" />
|
||||
<uses-permission android:name="android.permission.BLUETOOTH_CONNECT" />
|
||||
<uses-permission android:name="android.permission.BLUETOOTH_ADVERTISE" />
|
||||
|
||||
<!-- Legacy BLE (API < 31) -->
|
||||
<uses-permission android:name="android.permission.BLUETOOTH"
|
||||
android:maxSdkVersion="30" />
|
||||
<uses-permission android:name="android.permission.BLUETOOTH_ADMIN"
|
||||
android:maxSdkVersion="30" />
|
||||
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"
|
||||
android:maxSdkVersion="30" />
|
||||
|
||||
<uses-feature android:name="android.hardware.bluetooth_le" android:required="true" />
|
||||
|
||||
<application
|
||||
android:allowBackup="true"
|
||||
android:label="UWB Tag Config"
|
||||
android:theme="@style/Theme.MaterialComponents.DayNight.DarkActionBar">
|
||||
|
||||
<activity
|
||||
android:name=".UwbTagBleActivity"
|
||||
android:exported="true"
|
||||
android:launchMode="singleTop">
|
||||
<intent-filter>
|
||||
<action android:name="android.intent.action.MAIN" />
|
||||
<category android:name="android.intent.category.LAUNCHER" />
|
||||
</intent-filter>
|
||||
</activity>
|
||||
|
||||
</application>
|
||||
|
||||
</manifest>
|
||||
444
android/src/main/kotlin/com/saltylab/uwbtag/UwbTagBleActivity.kt
Normal file
444
android/src/main/kotlin/com/saltylab/uwbtag/UwbTagBleActivity.kt
Normal file
@ -0,0 +1,444 @@
|
||||
package com.saltylab.uwbtag
|
||||
|
||||
import android.Manifest
|
||||
import android.annotation.SuppressLint
|
||||
import android.bluetooth.*
|
||||
import android.bluetooth.le.*
|
||||
import android.content.Context
|
||||
import android.content.pm.PackageManager
|
||||
import android.os.Build
|
||||
import android.os.Bundle
|
||||
import android.os.Handler
|
||||
import android.os.Looper
|
||||
import android.view.LayoutInflater
|
||||
import android.view.View
|
||||
import android.view.ViewGroup
|
||||
import android.widget.Button
|
||||
import android.widget.TextView
|
||||
import android.widget.Toast
|
||||
import androidx.appcompat.app.AppCompatActivity
|
||||
import androidx.core.app.ActivityCompat
|
||||
import androidx.core.content.ContextCompat
|
||||
import androidx.recyclerview.widget.LinearLayoutManager
|
||||
import androidx.recyclerview.widget.RecyclerView
|
||||
import com.google.android.material.card.MaterialCardView
|
||||
import com.google.android.material.switchmaterial.SwitchMaterial
|
||||
import com.google.android.material.textfield.TextInputEditText
|
||||
import com.google.gson.Gson
|
||||
import com.saltylab.uwbtag.databinding.ActivityUwbTagBleBinding
|
||||
import java.util.UUID
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// GATT service / characteristic UUIDs
|
||||
// ---------------------------------------------------------------------------
|
||||
private val SERVICE_UUID = UUID.fromString("12345678-1234-5678-1234-56789abcdef0")
|
||||
private val CHAR_CONFIG_UUID = UUID.fromString("12345678-1234-5678-1234-56789abcdef1") // read/write JSON config
|
||||
private val CHAR_STATUS_UUID = UUID.fromString("12345678-1234-5678-1234-56789abcdef2") // notify: tag status string
|
||||
private val CHAR_BATT_UUID = UUID.fromString("12345678-1234-5678-1234-56789abcdef3") // notify: battery %
|
||||
private val CCCD_UUID = UUID.fromString("00002902-0000-1000-8000-00805f9b34fb")
|
||||
|
||||
// BLE scan timeout
|
||||
private const val SCAN_TIMEOUT_MS = 15_000L
|
||||
|
||||
// Permissions request code
|
||||
private const val REQ_PERMISSIONS = 1001
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Data model
|
||||
// ---------------------------------------------------------------------------
|
||||
data class TagConfig(
|
||||
val tag_name: String = "UWB_TAG_0001",
|
||||
val sleep_timeout_s: Int = 300,
|
||||
val display_brightness: Int = 50,
|
||||
val uwb_channel: Int = 9,
|
||||
val ranging_interval_ms: Int = 100,
|
||||
val battery_report: Boolean = true
|
||||
)
|
||||
|
||||
data class ScannedDevice(
|
||||
val name: String,
|
||||
val address: String,
|
||||
var rssi: Int,
|
||||
val device: BluetoothDevice
|
||||
)
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// RecyclerView adapter for scanned devices
|
||||
// ---------------------------------------------------------------------------
|
||||
class DeviceAdapter(
|
||||
private val onConnect: (ScannedDevice) -> Unit
|
||||
) : RecyclerView.Adapter<DeviceAdapter.VH>() {
|
||||
|
||||
private val items = mutableListOf<ScannedDevice>()
|
||||
|
||||
fun update(device: ScannedDevice) {
|
||||
val idx = items.indexOfFirst { it.address == device.address }
|
||||
if (idx >= 0) {
|
||||
items[idx] = device
|
||||
notifyItemChanged(idx)
|
||||
} else {
|
||||
items.add(device)
|
||||
notifyItemInserted(items.size - 1)
|
||||
}
|
||||
}
|
||||
|
||||
fun clear() {
|
||||
items.clear()
|
||||
notifyDataSetChanged()
|
||||
}
|
||||
|
||||
override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): VH {
|
||||
val view = LayoutInflater.from(parent.context)
|
||||
.inflate(R.layout.item_ble_device, parent, false)
|
||||
return VH(view)
|
||||
}
|
||||
|
||||
override fun onBindViewHolder(holder: VH, position: Int) = holder.bind(items[position])
|
||||
override fun getItemCount() = items.size
|
||||
|
||||
inner class VH(view: View) : RecyclerView.ViewHolder(view) {
|
||||
private val tvName = view.findViewById<TextView>(R.id.tvDeviceName)
|
||||
private val tvAddress = view.findViewById<TextView>(R.id.tvDeviceAddress)
|
||||
private val tvRssi = view.findViewById<TextView>(R.id.tvRssi)
|
||||
private val btnConn = view.findViewById<Button>(R.id.btnConnect)
|
||||
|
||||
fun bind(item: ScannedDevice) {
|
||||
tvName.text = item.name
|
||||
tvAddress.text = item.address
|
||||
tvRssi.text = "${item.rssi} dBm"
|
||||
btnConn.setOnClickListener { onConnect(item) }
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Activity
|
||||
// ---------------------------------------------------------------------------
|
||||
@SuppressLint("MissingPermission") // permissions checked at runtime before any BLE call
|
||||
class UwbTagBleActivity : AppCompatActivity() {
|
||||
|
||||
private lateinit var binding: ActivityUwbTagBleBinding
|
||||
private val gson = Gson()
|
||||
private val mainHandler = Handler(Looper.getMainLooper())
|
||||
|
||||
// BLE
|
||||
private val btManager by lazy { getSystemService(Context.BLUETOOTH_SERVICE) as BluetoothManager }
|
||||
private val btAdapter by lazy { btManager.adapter }
|
||||
private var bleScanner: BluetoothLeScanner? = null
|
||||
private var gatt: BluetoothGatt? = null
|
||||
private var configChar: BluetoothGattCharacteristic? = null
|
||||
private var statusChar: BluetoothGattCharacteristic? = null
|
||||
private var battChar: BluetoothGattCharacteristic? = null
|
||||
private var isScanning = false
|
||||
|
||||
private val deviceAdapter = DeviceAdapter(onConnect = ::connectToDevice)
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Lifecycle
|
||||
// ---------------------------------------------------------------------------
|
||||
override fun onCreate(savedInstanceState: Bundle?) {
|
||||
super.onCreate(savedInstanceState)
|
||||
binding = ActivityUwbTagBleBinding.inflate(layoutInflater)
|
||||
setContentView(binding.root)
|
||||
setSupportActionBar(binding.toolbar)
|
||||
|
||||
binding.rvDevices.layoutManager = LinearLayoutManager(this)
|
||||
binding.rvDevices.adapter = deviceAdapter
|
||||
|
||||
binding.btnScan.setOnClickListener {
|
||||
if (isScanning) stopScan() else startScanIfPermitted()
|
||||
}
|
||||
binding.btnDisconnect.setOnClickListener { disconnectGatt() }
|
||||
binding.btnReadConfig.setOnClickListener { readConfig() }
|
||||
binding.btnWriteConfig.setOnClickListener { writeConfig() }
|
||||
|
||||
requestBlePermissions()
|
||||
}
|
||||
|
||||
override fun onDestroy() {
|
||||
super.onDestroy()
|
||||
stopScan()
|
||||
disconnectGatt()
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Permissions
|
||||
// ---------------------------------------------------------------------------
|
||||
private fun requestBlePermissions() {
|
||||
val needed = mutableListOf<String>()
|
||||
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.S) {
|
||||
if (!hasPermission(Manifest.permission.BLUETOOTH_SCAN))
|
||||
needed += Manifest.permission.BLUETOOTH_SCAN
|
||||
if (!hasPermission(Manifest.permission.BLUETOOTH_CONNECT))
|
||||
needed += Manifest.permission.BLUETOOTH_CONNECT
|
||||
} else {
|
||||
if (!hasPermission(Manifest.permission.ACCESS_FINE_LOCATION))
|
||||
needed += Manifest.permission.ACCESS_FINE_LOCATION
|
||||
}
|
||||
if (needed.isNotEmpty()) {
|
||||
ActivityCompat.requestPermissions(this, needed.toTypedArray(), REQ_PERMISSIONS)
|
||||
}
|
||||
}
|
||||
|
||||
private fun hasPermission(perm: String) =
|
||||
ContextCompat.checkSelfPermission(this, perm) == PackageManager.PERMISSION_GRANTED
|
||||
|
||||
override fun onRequestPermissionsResult(
|
||||
requestCode: Int, permissions: Array<out String>, grantResults: IntArray
|
||||
) {
|
||||
super.onRequestPermissionsResult(requestCode, permissions, grantResults)
|
||||
if (requestCode == REQ_PERMISSIONS &&
|
||||
grantResults.any { it != PackageManager.PERMISSION_GRANTED }) {
|
||||
toast("BLE permissions required")
|
||||
}
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// BLE Scan
|
||||
// ---------------------------------------------------------------------------
|
||||
private fun startScanIfPermitted() {
|
||||
if (btAdapter?.isEnabled != true) { toast("Bluetooth is off"); return }
|
||||
bleScanner = btAdapter.bluetoothLeScanner
|
||||
val filter = ScanFilter.Builder()
|
||||
.setDeviceNamePattern("UWB_TAG_.*".toRegex().toPattern())
|
||||
.build()
|
||||
val settings = ScanSettings.Builder()
|
||||
.setScanMode(ScanSettings.SCAN_MODE_LOW_LATENCY)
|
||||
.build()
|
||||
deviceAdapter.clear()
|
||||
bleScanner?.startScan(listOf(filter), settings, scanCallback)
|
||||
isScanning = true
|
||||
binding.btnScan.text = "Stop"
|
||||
binding.tvScanStatus.text = "Scanning…"
|
||||
mainHandler.postDelayed({ stopScan() }, SCAN_TIMEOUT_MS)
|
||||
}
|
||||
|
||||
private fun stopScan() {
|
||||
bleScanner?.stopScan(scanCallback)
|
||||
isScanning = false
|
||||
binding.btnScan.text = "Scan"
|
||||
binding.tvScanStatus.text = "Scan stopped"
|
||||
}
|
||||
|
||||
private val scanCallback = object : ScanCallback() {
|
||||
override fun onScanResult(callbackType: Int, result: ScanResult) {
|
||||
val name = result.device.name ?: return
|
||||
if (!name.startsWith("UWB_TAG_")) return
|
||||
val dev = ScannedDevice(
|
||||
name = name,
|
||||
address = result.device.address,
|
||||
rssi = result.rssi,
|
||||
device = result.device
|
||||
)
|
||||
mainHandler.post { deviceAdapter.update(dev) }
|
||||
}
|
||||
|
||||
override fun onScanFailed(errorCode: Int) {
|
||||
mainHandler.post {
|
||||
binding.tvScanStatus.text = "Scan failed (code $errorCode)"
|
||||
isScanning = false
|
||||
binding.btnScan.text = "Scan"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// GATT Connection
|
||||
// ---------------------------------------------------------------------------
|
||||
private fun connectToDevice(scanned: ScannedDevice) {
|
||||
stopScan()
|
||||
binding.tvScanStatus.text = "Connecting to ${scanned.name}…"
|
||||
gatt = scanned.device.connectGatt(this, false, gattCallback, BluetoothDevice.TRANSPORT_LE)
|
||||
}
|
||||
|
||||
private fun disconnectGatt() {
|
||||
gatt?.disconnect()
|
||||
gatt?.close()
|
||||
gatt = null
|
||||
configChar = null
|
||||
statusChar = null
|
||||
battChar = null
|
||||
mainHandler.post {
|
||||
binding.cardConfig.visibility = View.GONE
|
||||
binding.tvScanStatus.text = "Disconnected"
|
||||
}
|
||||
}
|
||||
|
||||
private val gattCallback = object : BluetoothGattCallback() {
|
||||
|
||||
override fun onConnectionStateChange(g: BluetoothGatt, status: Int, newState: Int) {
|
||||
when (newState) {
|
||||
BluetoothProfile.STATE_CONNECTED -> {
|
||||
mainHandler.post { binding.tvScanStatus.text = "Connected — discovering services…" }
|
||||
g.discoverServices()
|
||||
}
|
||||
BluetoothProfile.STATE_DISCONNECTED -> {
|
||||
mainHandler.post {
|
||||
binding.cardConfig.visibility = View.GONE
|
||||
binding.tvScanStatus.text = "Disconnected"
|
||||
toast("Tag disconnected")
|
||||
}
|
||||
gatt?.close()
|
||||
gatt = null
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
override fun onServicesDiscovered(g: BluetoothGatt, status: Int) {
|
||||
if (status != BluetoothGatt.GATT_SUCCESS) {
|
||||
mainHandler.post { toast("Service discovery failed") }
|
||||
return
|
||||
}
|
||||
val service = g.getService(SERVICE_UUID)
|
||||
if (service == null) {
|
||||
mainHandler.post { toast("UWB config service not found on tag") }
|
||||
return
|
||||
}
|
||||
configChar = service.getCharacteristic(CHAR_CONFIG_UUID)
|
||||
statusChar = service.getCharacteristic(CHAR_STATUS_UUID)
|
||||
battChar = service.getCharacteristic(CHAR_BATT_UUID)
|
||||
|
||||
// Subscribe to status notifications
|
||||
statusChar?.let { enableNotifications(g, it) }
|
||||
battChar?.let { enableNotifications(g, it) }
|
||||
|
||||
// Initial config read
|
||||
configChar?.let { g.readCharacteristic(it) }
|
||||
|
||||
mainHandler.post {
|
||||
val devName = g.device.name ?: g.device.address
|
||||
binding.tvConnectedName.text = "Connected: $devName"
|
||||
binding.cardConfig.visibility = View.VISIBLE
|
||||
binding.tvScanStatus.text = "Connected to $devName"
|
||||
}
|
||||
}
|
||||
|
||||
override fun onCharacteristicRead(
|
||||
g: BluetoothGatt,
|
||||
characteristic: BluetoothGattCharacteristic,
|
||||
status: Int
|
||||
) {
|
||||
if (status != BluetoothGatt.GATT_SUCCESS) return
|
||||
if (characteristic.uuid == CHAR_CONFIG_UUID) {
|
||||
val json = characteristic.value?.toString(Charsets.UTF_8) ?: return
|
||||
val cfg = runCatching { gson.fromJson(json, TagConfig::class.java) }.getOrNull() ?: return
|
||||
mainHandler.post { populateFields(cfg) }
|
||||
}
|
||||
}
|
||||
|
||||
// API 33+ callback
|
||||
override fun onCharacteristicRead(
|
||||
g: BluetoothGatt,
|
||||
characteristic: BluetoothGattCharacteristic,
|
||||
value: ByteArray,
|
||||
status: Int
|
||||
) {
|
||||
if (status != BluetoothGatt.GATT_SUCCESS) return
|
||||
if (characteristic.uuid == CHAR_CONFIG_UUID) {
|
||||
val json = value.toString(Charsets.UTF_8)
|
||||
val cfg = runCatching { gson.fromJson(json, TagConfig::class.java) }.getOrNull() ?: return
|
||||
mainHandler.post { populateFields(cfg) }
|
||||
}
|
||||
}
|
||||
|
||||
override fun onCharacteristicWrite(
|
||||
g: BluetoothGatt,
|
||||
characteristic: BluetoothGattCharacteristic,
|
||||
status: Int
|
||||
) {
|
||||
val msg = if (status == BluetoothGatt.GATT_SUCCESS) "Config written" else "Write failed ($status)"
|
||||
mainHandler.post { toast(msg) }
|
||||
}
|
||||
|
||||
override fun onCharacteristicChanged(
|
||||
g: BluetoothGatt,
|
||||
characteristic: BluetoothGattCharacteristic
|
||||
) {
|
||||
val value = characteristic.value ?: return
|
||||
handleNotification(characteristic.uuid, value)
|
||||
}
|
||||
|
||||
// API 33+ callback
|
||||
override fun onCharacteristicChanged(
|
||||
g: BluetoothGatt,
|
||||
characteristic: BluetoothGattCharacteristic,
|
||||
value: ByteArray
|
||||
) {
|
||||
handleNotification(characteristic.uuid, value)
|
||||
}
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Notification helpers
|
||||
// ---------------------------------------------------------------------------
|
||||
private fun enableNotifications(g: BluetoothGatt, char: BluetoothGattCharacteristic) {
|
||||
g.setCharacteristicNotification(char, true)
|
||||
val descriptor = char.getDescriptor(CCCD_UUID) ?: return
|
||||
descriptor.value = BluetoothGattDescriptor.ENABLE_NOTIFICATION_VALUE
|
||||
g.writeDescriptor(descriptor)
|
||||
}
|
||||
|
||||
private fun handleNotification(uuid: UUID, value: ByteArray) {
|
||||
val text = value.toString(Charsets.UTF_8)
|
||||
mainHandler.post {
|
||||
when (uuid) {
|
||||
CHAR_STATUS_UUID -> binding.tvTagStatus.text = "Status: $text"
|
||||
CHAR_BATT_UUID -> {
|
||||
val pct = text.toIntOrNull() ?: return@post
|
||||
binding.tvTagStatus.text = binding.tvTagStatus.text.toString()
|
||||
.replace(Regex("\\| Batt:.*"), "")
|
||||
.trimEnd() + " | Batt: $pct%"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Config read / write
|
||||
// ---------------------------------------------------------------------------
|
||||
private fun readConfig() {
|
||||
val g = gatt ?: run { toast("Not connected"); return }
|
||||
val c = configChar ?: run { toast("Config char not found"); return }
|
||||
g.readCharacteristic(c)
|
||||
}
|
||||
|
||||
private fun writeConfig() {
|
||||
val g = gatt ?: run { toast("Not connected"); return }
|
||||
val c = configChar ?: run { toast("Config char not found"); return }
|
||||
val cfg = buildConfigFromFields()
|
||||
val json = gson.toJson(cfg)
|
||||
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
|
||||
g.writeCharacteristic(c, json.toByteArray(Charsets.UTF_8),
|
||||
BluetoothGattCharacteristic.WRITE_TYPE_DEFAULT)
|
||||
} else {
|
||||
@Suppress("DEPRECATION")
|
||||
c.value = json.toByteArray(Charsets.UTF_8)
|
||||
@Suppress("DEPRECATION")
|
||||
g.writeCharacteristic(c)
|
||||
}
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// UI helpers
|
||||
// ---------------------------------------------------------------------------
|
||||
private fun populateFields(cfg: TagConfig) {
|
||||
binding.etTagName.setText(cfg.tag_name)
|
||||
binding.etSleepTimeout.setText(cfg.sleep_timeout_s.toString())
|
||||
binding.etBrightness.setText(cfg.display_brightness.toString())
|
||||
binding.etUwbChannel.setText(cfg.uwb_channel.toString())
|
||||
binding.etRangingInterval.setText(cfg.ranging_interval_ms.toString())
|
||||
binding.switchBatteryReport.isChecked = cfg.battery_report
|
||||
}
|
||||
|
||||
private fun buildConfigFromFields() = TagConfig(
|
||||
tag_name = binding.etTagName.text?.toString() ?: "UWB_TAG_0001",
|
||||
sleep_timeout_s = binding.etSleepTimeout.text?.toString()?.toIntOrNull() ?: 300,
|
||||
display_brightness = binding.etBrightness.text?.toString()?.toIntOrNull() ?: 50,
|
||||
uwb_channel = binding.etUwbChannel.text?.toString()?.toIntOrNull() ?: 9,
|
||||
ranging_interval_ms = binding.etRangingInterval.text?.toString()?.toIntOrNull() ?: 100,
|
||||
battery_report = binding.switchBatteryReport.isChecked
|
||||
)
|
||||
|
||||
private fun toast(msg: String) =
|
||||
Toast.makeText(this, msg, Toast.LENGTH_SHORT).show()
|
||||
}
|
||||
238
android/src/main/res/layout/activity_uwb_tag_ble.xml
Normal file
238
android/src/main/res/layout/activity_uwb_tag_ble.xml
Normal file
@ -0,0 +1,238 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
|
||||
xmlns:app="http://schemas.android.com/apk/res-auto"
|
||||
android:layout_width="match_parent"
|
||||
android:layout_height="match_parent"
|
||||
android:orientation="vertical">
|
||||
|
||||
<androidx.appcompat.widget.Toolbar
|
||||
android:id="@+id/toolbar"
|
||||
android:layout_width="match_parent"
|
||||
android:layout_height="?attr/actionBarSize"
|
||||
android:background="?attr/colorPrimary"
|
||||
android:elevation="4dp"
|
||||
android:theme="@style/ThemeOverlay.AppCompat.Dark.ActionBar"
|
||||
app:title="UWB Tag BLE Config" />
|
||||
|
||||
<!-- Scan controls -->
|
||||
<LinearLayout
|
||||
android:layout_width="match_parent"
|
||||
android:layout_height="wrap_content"
|
||||
android:orientation="horizontal"
|
||||
android:padding="12dp"
|
||||
android:gravity="center_vertical">
|
||||
|
||||
<Button
|
||||
android:id="@+id/btnScan"
|
||||
style="@style/Widget.MaterialComponents.Button"
|
||||
android:layout_width="wrap_content"
|
||||
android:layout_height="wrap_content"
|
||||
android:text="Scan" />
|
||||
|
||||
<TextView
|
||||
android:id="@+id/tvScanStatus"
|
||||
android:layout_width="0dp"
|
||||
android:layout_height="wrap_content"
|
||||
android:layout_weight="1"
|
||||
android:layout_marginStart="12dp"
|
||||
android:text="Tap Scan to find UWB tags"
|
||||
android:textAppearance="@style/TextAppearance.MaterialComponents.Body2" />
|
||||
|
||||
</LinearLayout>
|
||||
|
||||
<!-- Scan results list -->
|
||||
<TextView
|
||||
android:layout_width="match_parent"
|
||||
android:layout_height="wrap_content"
|
||||
android:paddingHorizontal="12dp"
|
||||
android:text="Nearby Tags"
|
||||
android:textAppearance="@style/TextAppearance.MaterialComponents.Subtitle1"
|
||||
android:textStyle="bold" />
|
||||
|
||||
<androidx.recyclerview.widget.RecyclerView
|
||||
android:id="@+id/rvDevices"
|
||||
android:layout_width="match_parent"
|
||||
android:layout_height="0dp"
|
||||
android:layout_weight="1"
|
||||
android:padding="8dp"
|
||||
android:clipToPadding="false" />
|
||||
|
||||
<!-- Connected device config panel -->
|
||||
<com.google.android.material.card.MaterialCardView
|
||||
android:id="@+id/cardConfig"
|
||||
android:layout_width="match_parent"
|
||||
android:layout_height="wrap_content"
|
||||
android:layout_margin="8dp"
|
||||
android:visibility="gone"
|
||||
app:cardElevation="4dp">
|
||||
|
||||
<LinearLayout
|
||||
android:layout_width="match_parent"
|
||||
android:layout_height="wrap_content"
|
||||
android:orientation="vertical"
|
||||
android:padding="12dp">
|
||||
|
||||
<LinearLayout
|
||||
android:layout_width="match_parent"
|
||||
android:layout_height="wrap_content"
|
||||
android:orientation="horizontal"
|
||||
android:gravity="center_vertical">
|
||||
|
||||
<TextView
|
||||
android:id="@+id/tvConnectedName"
|
||||
android:layout_width="0dp"
|
||||
android:layout_height="wrap_content"
|
||||
android:layout_weight="1"
|
||||
android:text="Connected: —"
|
||||
android:textAppearance="@style/TextAppearance.MaterialComponents.Subtitle1"
|
||||
android:textStyle="bold" />
|
||||
|
||||
<Button
|
||||
android:id="@+id/btnDisconnect"
|
||||
style="@style/Widget.MaterialComponents.Button.OutlinedButton"
|
||||
android:layout_width="wrap_content"
|
||||
android:layout_height="wrap_content"
|
||||
android:text="Disconnect" />
|
||||
|
||||
</LinearLayout>
|
||||
|
||||
<!-- tag_name -->
|
||||
<com.google.android.material.textfield.TextInputLayout
|
||||
style="@style/Widget.MaterialComponents.TextInputLayout.OutlinedBox.Dense"
|
||||
android:layout_width="match_parent"
|
||||
android:layout_height="wrap_content"
|
||||
android:layout_marginTop="8dp"
|
||||
android:hint="Tag Name">
|
||||
<com.google.android.material.textfield.TextInputEditText
|
||||
android:id="@+id/etTagName"
|
||||
android:layout_width="match_parent"
|
||||
android:layout_height="wrap_content"
|
||||
android:inputType="text" />
|
||||
</com.google.android.material.textfield.TextInputLayout>
|
||||
|
||||
<!-- sleep_timeout_s and uwb_channel (row) -->
|
||||
<LinearLayout
|
||||
android:layout_width="match_parent"
|
||||
android:layout_height="wrap_content"
|
||||
android:orientation="horizontal"
|
||||
android:layout_marginTop="4dp">
|
||||
|
||||
<com.google.android.material.textfield.TextInputLayout
|
||||
style="@style/Widget.MaterialComponents.TextInputLayout.OutlinedBox.Dense"
|
||||
android:layout_width="0dp"
|
||||
android:layout_height="wrap_content"
|
||||
android:layout_weight="1"
|
||||
android:layout_marginEnd="4dp"
|
||||
android:hint="Sleep Timeout (s)">
|
||||
<com.google.android.material.textfield.TextInputEditText
|
||||
android:id="@+id/etSleepTimeout"
|
||||
android:layout_width="match_parent"
|
||||
android:layout_height="wrap_content"
|
||||
android:inputType="number" />
|
||||
</com.google.android.material.textfield.TextInputLayout>
|
||||
|
||||
<com.google.android.material.textfield.TextInputLayout
|
||||
style="@style/Widget.MaterialComponents.TextInputLayout.OutlinedBox.Dense"
|
||||
android:layout_width="0dp"
|
||||
android:layout_height="wrap_content"
|
||||
android:layout_weight="1"
|
||||
android:layout_marginStart="4dp"
|
||||
android:hint="UWB Channel">
|
||||
<com.google.android.material.textfield.TextInputEditText
|
||||
android:id="@+id/etUwbChannel"
|
||||
android:layout_width="match_parent"
|
||||
android:layout_height="wrap_content"
|
||||
android:inputType="number" />
|
||||
</com.google.android.material.textfield.TextInputLayout>
|
||||
|
||||
</LinearLayout>
|
||||
|
||||
<!-- display_brightness and ranging_interval_ms (row) -->
|
||||
<LinearLayout
|
||||
android:layout_width="match_parent"
|
||||
android:layout_height="wrap_content"
|
||||
android:orientation="horizontal"
|
||||
android:layout_marginTop="4dp">
|
||||
|
||||
<com.google.android.material.textfield.TextInputLayout
|
||||
style="@style/Widget.MaterialComponents.TextInputLayout.OutlinedBox.Dense"
|
||||
android:layout_width="0dp"
|
||||
android:layout_height="wrap_content"
|
||||
android:layout_weight="1"
|
||||
android:layout_marginEnd="4dp"
|
||||
android:hint="Brightness (0-100)">
|
||||
<com.google.android.material.textfield.TextInputEditText
|
||||
android:id="@+id/etBrightness"
|
||||
android:layout_width="match_parent"
|
||||
android:layout_height="wrap_content"
|
||||
android:inputType="number" />
|
||||
</com.google.android.material.textfield.TextInputLayout>
|
||||
|
||||
<com.google.android.material.textfield.TextInputLayout
|
||||
style="@style/Widget.MaterialComponents.TextInputLayout.OutlinedBox.Dense"
|
||||
android:layout_width="0dp"
|
||||
android:layout_height="wrap_content"
|
||||
android:layout_weight="1"
|
||||
android:layout_marginStart="4dp"
|
||||
android:hint="Ranging Interval (ms)">
|
||||
<com.google.android.material.textfield.TextInputEditText
|
||||
android:id="@+id/etRangingInterval"
|
||||
android:layout_width="match_parent"
|
||||
android:layout_height="wrap_content"
|
||||
android:inputType="number" />
|
||||
</com.google.android.material.textfield.TextInputLayout>
|
||||
|
||||
</LinearLayout>
|
||||
|
||||
<!-- battery_report toggle -->
|
||||
<com.google.android.material.switchmaterial.SwitchMaterial
|
||||
android:id="@+id/switchBatteryReport"
|
||||
android:layout_width="wrap_content"
|
||||
android:layout_height="wrap_content"
|
||||
android:layout_marginTop="8dp"
|
||||
android:text="Battery Reporting" />
|
||||
|
||||
<!-- Action buttons -->
|
||||
<LinearLayout
|
||||
android:layout_width="match_parent"
|
||||
android:layout_height="wrap_content"
|
||||
android:orientation="horizontal"
|
||||
android:layout_marginTop="8dp">
|
||||
|
||||
<Button
|
||||
android:id="@+id/btnReadConfig"
|
||||
style="@style/Widget.MaterialComponents.Button.OutlinedButton"
|
||||
android:layout_width="0dp"
|
||||
android:layout_height="wrap_content"
|
||||
android:layout_weight="1"
|
||||
android:layout_marginEnd="4dp"
|
||||
android:text="Read" />
|
||||
|
||||
<Button
|
||||
android:id="@+id/btnWriteConfig"
|
||||
style="@style/Widget.MaterialComponents.Button"
|
||||
android:layout_width="0dp"
|
||||
android:layout_height="wrap_content"
|
||||
android:layout_weight="1"
|
||||
android:layout_marginStart="4dp"
|
||||
android:text="Write" />
|
||||
|
||||
</LinearLayout>
|
||||
|
||||
<!-- Status notifications from tag -->
|
||||
<TextView
|
||||
android:id="@+id/tvTagStatus"
|
||||
android:layout_width="match_parent"
|
||||
android:layout_height="wrap_content"
|
||||
android:layout_marginTop="8dp"
|
||||
android:background="#1A000000"
|
||||
android:fontFamily="monospace"
|
||||
android:padding="8dp"
|
||||
android:text="Tag status: —"
|
||||
android:textAppearance="@style/TextAppearance.MaterialComponents.Caption" />
|
||||
|
||||
</LinearLayout>
|
||||
|
||||
</com.google.android.material.card.MaterialCardView>
|
||||
|
||||
</LinearLayout>
|
||||
60
android/src/main/res/layout/item_ble_device.xml
Normal file
60
android/src/main/res/layout/item_ble_device.xml
Normal file
@ -0,0 +1,60 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<com.google.android.material.card.MaterialCardView
|
||||
xmlns:android="http://schemas.android.com/apk/res/android"
|
||||
xmlns:app="http://schemas.android.com/apk/res-auto"
|
||||
android:layout_width="match_parent"
|
||||
android:layout_height="wrap_content"
|
||||
android:layout_margin="4dp"
|
||||
app:cardElevation="2dp"
|
||||
android:clickable="true"
|
||||
android:focusable="true">
|
||||
|
||||
<LinearLayout
|
||||
android:layout_width="match_parent"
|
||||
android:layout_height="wrap_content"
|
||||
android:orientation="horizontal"
|
||||
android:padding="12dp"
|
||||
android:gravity="center_vertical">
|
||||
|
||||
<LinearLayout
|
||||
android:layout_width="0dp"
|
||||
android:layout_height="wrap_content"
|
||||
android:layout_weight="1"
|
||||
android:orientation="vertical">
|
||||
|
||||
<TextView
|
||||
android:id="@+id/tvDeviceName"
|
||||
android:layout_width="match_parent"
|
||||
android:layout_height="wrap_content"
|
||||
android:text="UWB_TAG_XXXX"
|
||||
android:textAppearance="@style/TextAppearance.MaterialComponents.Subtitle2"
|
||||
android:textStyle="bold" />
|
||||
|
||||
<TextView
|
||||
android:id="@+id/tvDeviceAddress"
|
||||
android:layout_width="match_parent"
|
||||
android:layout_height="wrap_content"
|
||||
android:text="XX:XX:XX:XX:XX:XX"
|
||||
android:textAppearance="@style/TextAppearance.MaterialComponents.Caption" />
|
||||
|
||||
</LinearLayout>
|
||||
|
||||
<TextView
|
||||
android:id="@+id/tvRssi"
|
||||
android:layout_width="wrap_content"
|
||||
android:layout_height="wrap_content"
|
||||
android:text="-70 dBm"
|
||||
android:textAppearance="@style/TextAppearance.MaterialComponents.Caption"
|
||||
android:textColor="?attr/colorSecondary" />
|
||||
|
||||
<Button
|
||||
android:id="@+id/btnConnect"
|
||||
style="@style/Widget.MaterialComponents.Button.OutlinedButton"
|
||||
android:layout_width="wrap_content"
|
||||
android:layout_height="wrap_content"
|
||||
android:layout_marginStart="8dp"
|
||||
android:text="Connect" />
|
||||
|
||||
</LinearLayout>
|
||||
|
||||
</com.google.android.material.card.MaterialCardView>
|
||||
296
chassis/vesc_mount.scad
Normal file
296
chassis/vesc_mount.scad
Normal file
@ -0,0 +1,296 @@
|
||||
// ============================================================
|
||||
// vesc_mount.scad — FSESC 6.7 Pro Mini Dual ESC Mount Cradle
|
||||
// Issue #699 / sl-mechanical 2026-03-17
|
||||
// ============================================================
|
||||
// Open-top tray for Flipsky FSESC 6.7 Pro Mini Dual (~100 × 68 × 28 mm).
|
||||
// Attaches to 2020 aluminium T-slot rail via 4× M5 T-nuts
|
||||
// (2× per rail, two parallel rails, 60 mm bolt spacing in X,
|
||||
// 20 mm bolt spacing in Y matching 2020 slot pitch).
|
||||
//
|
||||
// Connector access:
|
||||
// XT60 battery inputs — X− end wall cutouts (2 connectors, side-by-side)
|
||||
// XT30 motor outputs — Y+ and Y− side wall cutouts (2 per side wall)
|
||||
// CAN/UART terminal — X+ end wall cutout (screw terminal, wire exit)
|
||||
//
|
||||
// Ventilation:
|
||||
// Open top face — heatsink fins fully exposed
|
||||
// Floor grille slots — under-board airflow
|
||||
// Side vent louvres — 4 slots on each Y± wall at heatsink height
|
||||
//
|
||||
// Retention: 4× M3 heat-set insert boss in floor — board screws down through
|
||||
// ESC mounting holes via M3×8 FHCS. Board sits on 4 mm raised posts for
|
||||
// under-board airflow.
|
||||
//
|
||||
// ⚠ VERIFY WITH CALIPERS BEFORE PRINTING:
|
||||
// PCB_L, PCB_W board outline
|
||||
// XT60_W, XT60_H XT60 shell at X− edge
|
||||
// XT30_W, XT30_H XT30 shells at Y± edges
|
||||
// TERM_W, TERM_H CAN screw terminal at X+ edge
|
||||
// MOUNT_X1/X2, MOUNT_Y1/Y2 ESC board mounting hole pattern
|
||||
//
|
||||
// Print settings (PETG):
|
||||
// 3 perimeters, 40 % gyroid infill, no supports, 0.2 mm layer
|
||||
// Print orientation: open face UP (as modelled)
|
||||
//
|
||||
// BOM:
|
||||
// 4 × M5×10 BHCS + 4 × M5 slide-in T-nut (2020 rail)
|
||||
// 4 × M3 heat-set insert (Voron-style, OD 4.5 mm × 4 mm deep)
|
||||
// 4 × M3×8 FHCS (board retention)
|
||||
//
|
||||
// Export commands:
|
||||
// openscad -D 'RENDER="mount"' -o vesc_mount.stl vesc_mount.scad
|
||||
// openscad -D 'RENDER="assembly"' -o vesc_assembly.png vesc_mount.scad
|
||||
// ============================================================
|
||||
|
||||
RENDER = "assembly"; // mount | assembly
|
||||
|
||||
$fn = 48;
|
||||
EPS = 0.01;
|
||||
|
||||
// ── ⚠ Verify before printing ─────────────────────────────────
|
||||
// FSESC 6.7 Pro Mini Dual PCB
|
||||
PCB_L = 100.0; // board length (X: XT60 end → CAN terminal end)
|
||||
PCB_W = 68.0; // board width (Y)
|
||||
PCB_T = 2.0; // board thickness (incl. bottom-side components)
|
||||
COMP_H = 26.0; // tallest component above board top face (heatsink ~26 mm)
|
||||
|
||||
// XT60 battery connectors at X− end (2 connectors, side-by-side)
|
||||
XT60_W = 16.0; // each XT60 shell width (Y)
|
||||
XT60_H = 16.0; // each XT60 shell height (Z) above board surface
|
||||
XT60_Z0 = 0.0; // connector bottom offset above board surface
|
||||
// Y centres of each XT60 measured from PCB Y− edge
|
||||
XT60_Y1 = 16.0;
|
||||
XT60_Y2 = 52.0;
|
||||
|
||||
// XT30 motor output connectors at Y± sides (2 per side)
|
||||
XT30_W = 10.5; // each XT30 shell width (X span)
|
||||
XT30_H = 12.0; // each XT30 shell height (Z) above board surface
|
||||
XT30_Z0 = 0.5; // connector bottom offset above board surface
|
||||
// X centres measured from PCB X− edge (same layout both Y− and Y+ sides)
|
||||
XT30_X1 = 22.0;
|
||||
XT30_X2 = 78.0;
|
||||
|
||||
// CAN / UART screw terminal block at X+ end (3-pos 3.5 mm pitch)
|
||||
TERM_W = 14.0; // terminal block Y span
|
||||
TERM_H = 10.0; // terminal block height above board surface
|
||||
TERM_Z0 = 0.5; // terminal bottom offset above board surface
|
||||
TERM_Y_CTR = PCB_W / 2;
|
||||
|
||||
// ── ESC board mounting hole pattern ──────────────────────────
|
||||
// 4 corner holes, 4 mm inset from each PCB edge
|
||||
MOUNT_INSET = 4.0;
|
||||
MOUNT_X1 = MOUNT_INSET;
|
||||
MOUNT_X2 = PCB_L - MOUNT_INSET;
|
||||
MOUNT_Y1 = MOUNT_INSET;
|
||||
MOUNT_Y2 = PCB_W - MOUNT_INSET;
|
||||
|
||||
M3_INSERT_OD = 4.6; // Voron M3 heat-set insert press-fit OD
|
||||
M3_INSERT_H = 4.0; // insert depth
|
||||
M3_CLEAR_D = 3.4; // M3 clearance bore below insert
|
||||
|
||||
// ── Cradle geometry ──────────────────────────────────────────
|
||||
WALL_T = 2.8; // side / end wall thickness
|
||||
FLOOR_T = 4.5; // floor plate thickness (fits M5 BHCS head pocket)
|
||||
POST_H = 4.0; // standoff post height (board lifts off floor for airflow)
|
||||
CL_SIDE = 0.35; // Y clearance per side
|
||||
CL_END = 0.40; // X clearance per end
|
||||
|
||||
INN_W = PCB_W + 2*CL_SIDE;
|
||||
INN_L = PCB_L + 2*CL_END;
|
||||
INN_H = POST_H + PCB_T + COMP_H + 1.5;
|
||||
|
||||
OTR_W = INN_W + 2*WALL_T;
|
||||
OTR_L = INN_L + 2*WALL_T;
|
||||
OTR_H = FLOOR_T + INN_H;
|
||||
|
||||
PCB_X0 = WALL_T + CL_END;
|
||||
PCB_Y0 = WALL_T + CL_SIDE;
|
||||
PCB_Z0 = FLOOR_T + POST_H;
|
||||
|
||||
// ── M5 T-nut mount (2020 rail) ────────────────────────────────
|
||||
// 4 bolts: 2 columns (X) × 2 rows (Y), centred on body
|
||||
M5_D = 5.3;
|
||||
M5_HEAD_D = 9.5;
|
||||
M5_HEAD_H = 3.0;
|
||||
M5_SPAC_X = 60.0; // X bolt spacing
|
||||
M5_SPAC_Y = 20.0; // Y bolt spacing (2020 T-slot pitch)
|
||||
|
||||
// ── Floor ventilation grille ──────────────────────────────────
|
||||
GRILLE_SLOT_W = 4.0;
|
||||
GRILLE_SLOT_T = FLOOR_T - 1.5;
|
||||
GRILLE_PITCH = 10.0;
|
||||
GRILLE_X0 = WALL_T + 14;
|
||||
GRILLE_X_LEN = OTR_L - 2*WALL_T - 28;
|
||||
GRILLE_N = floor((INN_W - 10) / GRILLE_PITCH);
|
||||
|
||||
// ── Side vent louvres on Y± walls ────────────────────────────
|
||||
LOUV_H = 5.0;
|
||||
LOUV_W = 12.0;
|
||||
LOUV_Z = FLOOR_T + POST_H + PCB_T + 4.0; // mid-heatsink height
|
||||
LOUV_N = 4;
|
||||
LOUV_PITCH = (OTR_L - 2*WALL_T - 20) / max(LOUV_N - 1, 1);
|
||||
|
||||
// ── CAN wire strain relief bosses (X+ end) ───────────────────
|
||||
SR_BOSS_OD = 7.0;
|
||||
SR_BOSS_H = 6.0;
|
||||
SR_SLOT_W = 3.5;
|
||||
SR_SLOT_T = 2.2;
|
||||
SR_Y1 = WALL_T + INN_W * 0.25;
|
||||
SR_Y2 = WALL_T + INN_W * 0.75;
|
||||
SR_X = OTR_L - WALL_T - SR_BOSS_OD/2 - 2.5;
|
||||
|
||||
// ─────────────────────────────────────────────────────────────
|
||||
module m3_insert_boss() {
|
||||
// Solid post with heat-set insert bore from top
|
||||
post_h = FLOOR_T + POST_H;
|
||||
difference() {
|
||||
cylinder(d = M3_INSERT_OD + 3.2, h = post_h);
|
||||
// Insert bore from top
|
||||
translate([0, 0, post_h - M3_INSERT_H])
|
||||
cylinder(d = M3_INSERT_OD, h = M3_INSERT_H + EPS);
|
||||
// Clearance bore from bottom
|
||||
translate([0, 0, -EPS])
|
||||
cylinder(d = M3_CLEAR_D, h = post_h - M3_INSERT_H + EPS);
|
||||
}
|
||||
}
|
||||
|
||||
module vesc_mount() {
|
||||
difference() {
|
||||
union() {
|
||||
// Main body
|
||||
cube([OTR_L, OTR_W, OTR_H]);
|
||||
|
||||
// M3 insert bosses at board mounting corners
|
||||
for (mx = [MOUNT_X1, MOUNT_X2])
|
||||
for (my = [MOUNT_Y1, MOUNT_Y2])
|
||||
translate([PCB_X0 + mx, PCB_Y0 + my, 0])
|
||||
m3_insert_boss();
|
||||
|
||||
// CAN strain relief bosses on X+ end
|
||||
for (sy = [SR_Y1, SR_Y2])
|
||||
translate([SR_X, sy, 0])
|
||||
cylinder(d = SR_BOSS_OD, h = SR_BOSS_H);
|
||||
}
|
||||
|
||||
// ── Interior cavity (open top) ─────────────────────────
|
||||
translate([WALL_T, WALL_T, FLOOR_T])
|
||||
cube([INN_L, INN_W, INN_H + EPS]);
|
||||
|
||||
// ── XT60 cutouts at X− end (2 connectors) ──────────────
|
||||
for (yc = [XT60_Y1, XT60_Y2])
|
||||
translate([-EPS,
|
||||
PCB_Y0 + yc - (XT60_W + 2.0)/2,
|
||||
PCB_Z0 + XT60_Z0 - 0.5])
|
||||
cube([WALL_T + 2*EPS, XT60_W + 2.0, XT60_H + 3.0]);
|
||||
|
||||
// ── XT30 cutouts at Y− side (2 connectors) ─────────────
|
||||
for (xc = [XT30_X1, XT30_X2])
|
||||
translate([PCB_X0 + xc - (XT30_W + 2.0)/2,
|
||||
-EPS,
|
||||
PCB_Z0 + XT30_Z0 - 0.5])
|
||||
cube([XT30_W + 2.0, WALL_T + 2*EPS, XT30_H + 3.0]);
|
||||
|
||||
// ── XT30 cutouts at Y+ side (2 connectors) ─────────────
|
||||
for (xc = [XT30_X1, XT30_X2])
|
||||
translate([PCB_X0 + xc - (XT30_W + 2.0)/2,
|
||||
OTR_W - WALL_T - EPS,
|
||||
PCB_Z0 + XT30_Z0 - 0.5])
|
||||
cube([XT30_W + 2.0, WALL_T + 2*EPS, XT30_H + 3.0]);
|
||||
|
||||
// ── CAN terminal cutout at X+ end ──────────────────────
|
||||
translate([OTR_L - WALL_T - EPS,
|
||||
PCB_Y0 + TERM_Y_CTR - (TERM_W + 3.0)/2,
|
||||
PCB_Z0 + TERM_Z0 - 0.5])
|
||||
cube([WALL_T + 2*EPS, TERM_W + 3.0, TERM_H + 5.0]);
|
||||
|
||||
// ── Floor ventilation grille ───────────────────────────
|
||||
for (i = [0 : GRILLE_N - 1]) {
|
||||
sy = WALL_T + 5 + i * GRILLE_PITCH;
|
||||
translate([GRILLE_X0, sy, -EPS])
|
||||
cube([GRILLE_X_LEN, GRILLE_SLOT_W, GRILLE_SLOT_T + EPS]);
|
||||
}
|
||||
|
||||
// ── Side vent louvres — Y− wall ────────────────────────
|
||||
for (i = [0 : LOUV_N - 1]) {
|
||||
lx = WALL_T + 10 + i * LOUV_PITCH;
|
||||
translate([lx, -EPS, LOUV_Z])
|
||||
cube([LOUV_W, WALL_T + 2*EPS, LOUV_H]);
|
||||
}
|
||||
|
||||
// ── Side vent louvres — Y+ wall ────────────────────────
|
||||
for (i = [0 : LOUV_N - 1]) {
|
||||
lx = WALL_T + 10 + i * LOUV_PITCH;
|
||||
translate([lx, OTR_W - WALL_T - EPS, LOUV_Z])
|
||||
cube([LOUV_W, WALL_T + 2*EPS, LOUV_H]);
|
||||
}
|
||||
|
||||
// ── M5 BHCS head pockets (4 bolts, bottom face) ────────
|
||||
for (mx = [OTR_L/2 - M5_SPAC_X/2, OTR_L/2 + M5_SPAC_X/2])
|
||||
for (my = [OTR_W/2 - M5_SPAC_Y/2, OTR_W/2 + M5_SPAC_Y/2])
|
||||
translate([mx, my, -EPS]) {
|
||||
cylinder(d = M5_D, h = FLOOR_T + 2*EPS);
|
||||
cylinder(d = M5_HEAD_D, h = M5_HEAD_H + EPS);
|
||||
}
|
||||
|
||||
// ── Zip-tie slots through CAN strain relief bosses ─────
|
||||
for (sy = [SR_Y1, SR_Y2])
|
||||
translate([SR_X, sy, SR_BOSS_H/2 - SR_SLOT_T/2])
|
||||
rotate([0, 90, 0])
|
||||
cube([SR_SLOT_T, SR_SLOT_W, SR_BOSS_OD + 2*EPS],
|
||||
center = true);
|
||||
|
||||
// ── Weight-relief pocket in floor underside ─────────────
|
||||
translate([WALL_T + 16, WALL_T + 6, -EPS])
|
||||
cube([OTR_L - 2*WALL_T - 32, OTR_W - 2*WALL_T - 12,
|
||||
FLOOR_T - 2.0 + EPS]);
|
||||
}
|
||||
}
|
||||
|
||||
// ── Assembly preview ─────────────────────────────────────────
|
||||
if (RENDER == "assembly") {
|
||||
color("DimGray", 0.93) vesc_mount();
|
||||
|
||||
// Phantom PCB
|
||||
color("ForestGreen", 0.30)
|
||||
translate([PCB_X0, PCB_Y0, PCB_Z0])
|
||||
cube([PCB_L, PCB_W, PCB_T]);
|
||||
|
||||
// Phantom heatsink / component block
|
||||
color("SlateGray", 0.22)
|
||||
translate([PCB_X0, PCB_Y0, PCB_Z0 + PCB_T])
|
||||
cube([PCB_L, PCB_W, COMP_H]);
|
||||
|
||||
// XT60 connector highlights (X− end)
|
||||
for (yc = [XT60_Y1, XT60_Y2])
|
||||
color("Gold", 0.85)
|
||||
translate([-2,
|
||||
PCB_Y0 + yc - XT60_W/2,
|
||||
PCB_Z0 + XT60_Z0])
|
||||
cube([WALL_T + 3, XT60_W, XT60_H]);
|
||||
|
||||
// XT30 connector highlights — Y− side
|
||||
for (xc = [XT30_X1, XT30_X2])
|
||||
color("OrangeRed", 0.80)
|
||||
translate([PCB_X0 + xc - XT30_W/2,
|
||||
-2,
|
||||
PCB_Z0 + XT30_Z0])
|
||||
cube([XT30_W, WALL_T + 3, XT30_H]);
|
||||
|
||||
// XT30 connector highlights — Y+ side
|
||||
for (xc = [XT30_X1, XT30_X2])
|
||||
color("OrangeRed", 0.80)
|
||||
translate([PCB_X0 + xc - XT30_W/2,
|
||||
OTR_W - WALL_T - 1,
|
||||
PCB_Z0 + XT30_Z0])
|
||||
cube([XT30_W, WALL_T + 3, XT30_H]);
|
||||
|
||||
// CAN terminal highlight
|
||||
color("Tomato", 0.75)
|
||||
translate([OTR_L - WALL_T - 1,
|
||||
PCB_Y0 + TERM_Y_CTR - TERM_W/2,
|
||||
PCB_Z0 + TERM_Z0])
|
||||
cube([WALL_T + 3, TERM_W, TERM_H]);
|
||||
|
||||
} else {
|
||||
vesc_mount();
|
||||
}
|
||||
@ -49,6 +49,9 @@ rosbridge_websocket:
|
||||
"/cmd_vel",
|
||||
"/saltybot/imu",
|
||||
"/saltybot/balance_state",
|
||||
"/saltybot/barometer",
|
||||
"/vesc/left/state",
|
||||
"/vesc/right/state",
|
||||
"/tf",
|
||||
"/tf_static"]
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
"""
|
||||
can_monitor.launch.py — Lightweight rosbridge server for CAN sensor dashboard (Issue #697)
|
||||
|
||||
Starts rosbridge_websocket on port 9090 with a whitelist limited to the five
|
||||
topics consumed by can_monitor_panel.html:
|
||||
|
||||
/saltybot/imu sensor_msgs/Imu — IMU attitude
|
||||
/saltybot/balance_state std_msgs/String (JSON) — balance PID state
|
||||
/saltybot/barometer std_msgs/String (JSON) — pressure / temp / altitude
|
||||
/vesc/left/state std_msgs/String (JSON) — left VESC telemetry
|
||||
/vesc/right/state std_msgs/String (JSON) — right VESC telemetry
|
||||
|
||||
Usage:
|
||||
ros2 launch saltybot_bringup can_monitor.launch.py
|
||||
|
||||
# Override port if needed:
|
||||
ros2 launch saltybot_bringup can_monitor.launch.py port:=9091
|
||||
|
||||
Verify:
|
||||
# From a browser on the same LAN:
|
||||
# var ros = new ROSLIB.Ros({ url: 'ws://<jetson-ip>:9090' });
|
||||
# ros.on('connection', () => console.log('connected'));
|
||||
"""
|
||||
|
||||
import os
|
||||
from launch import LaunchDescription
|
||||
from launch.actions import DeclareLaunchArgument
|
||||
from launch.substitutions import LaunchConfiguration
|
||||
from launch_ros.actions import Node
|
||||
|
||||
|
||||
# Topics exposed to the CAN monitor WebUI panel.
|
||||
_TOPICS = [
|
||||
'/saltybot/imu',
|
||||
'/saltybot/balance_state',
|
||||
'/saltybot/barometer',
|
||||
'/vesc/left/state',
|
||||
'/vesc/right/state',
|
||||
]
|
||||
|
||||
_TOPICS_GLOB = '[' + ', '.join(f'"{t}"' for t in _TOPICS) + ']'
|
||||
|
||||
|
||||
def generate_launch_description():
|
||||
port_arg = DeclareLaunchArgument(
|
||||
'port',
|
||||
default_value='9090',
|
||||
description='WebSocket port for rosbridge (default 9090)',
|
||||
)
|
||||
|
||||
rosbridge = Node(
|
||||
package='rosbridge_server',
|
||||
executable='rosbridge_websocket',
|
||||
name='rosbridge_websocket',
|
||||
parameters=[{
|
||||
'port': LaunchConfiguration('port'),
|
||||
'host': '0.0.0.0',
|
||||
'authenticate': False,
|
||||
'max_message_size': 1000000, # 1 MB — no large map payloads needed
|
||||
'topics_glob': _TOPICS_GLOB,
|
||||
'services_glob': '[]',
|
||||
'params_glob': '[]',
|
||||
'unregister_timeout': 10.0,
|
||||
'fragment_timeout': 600,
|
||||
'delay_between_messages': 0,
|
||||
}],
|
||||
output='screen',
|
||||
)
|
||||
|
||||
return LaunchDescription([port_arg, rosbridge])
|
||||
33
jetson/ros2_ws/src/saltybot_can_e2e_test/package.xml
Normal file
33
jetson/ros2_ws/src/saltybot_can_e2e_test/package.xml
Normal file
@ -0,0 +1,33 @@
|
||||
<?xml version="1.0"?>
|
||||
<?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
|
||||
<package format="3">
|
||||
<name>saltybot_can_e2e_test</name>
|
||||
<version>0.1.0</version>
|
||||
<description>
|
||||
End-to-end CAN integration test suite for the SaltyBot Orin↔Mamba↔VESC full loop.
|
||||
|
||||
Tests verify the complete CAN pipeline: drive commands, heartbeat timeout,
|
||||
e-stop escalation, mode switching, and FC_VESC status broadcasts.
|
||||
|
||||
No real hardware or a running ROS2 system is required.
|
||||
Run with: python -m pytest test/ -v
|
||||
|
||||
Issue: https://gitea.vayrette.com/seb/saltylab-firmware/issues/695
|
||||
</description>
|
||||
<maintainer email="sl-jetson@saltylab.local">sl-jetson</maintainer>
|
||||
<license>MIT</license>
|
||||
|
||||
<!-- Runtime dependency on saltybot_can_bridge for mamba_protocol -->
|
||||
<exec_depend>saltybot_can_bridge</exec_depend>
|
||||
|
||||
<buildtool_depend>ament_python</buildtool_depend>
|
||||
|
||||
<test_depend>ament_copyright</test_depend>
|
||||
<test_depend>ament_flake8</test_depend>
|
||||
<test_depend>ament_pep257</test_depend>
|
||||
<test_depend>python3-pytest</test_depend>
|
||||
|
||||
<export>
|
||||
<build_type>ament_python</build_type>
|
||||
</export>
|
||||
</package>
|
||||
@ -0,0 +1 @@
|
||||
# saltybot_can_e2e_test — End-to-end CAN integration test helpers
|
||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
@ -0,0 +1,160 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
can_mock.py — Mock CAN bus for unit/integration tests.
|
||||
|
||||
Implements the same minimal interface as python-can's Bus class so test code
|
||||
can inject frames and capture outbound traffic without real hardware or a
|
||||
running SocketCAN interface.
|
||||
|
||||
Interface
|
||||
---------
|
||||
MockCANBus.send(msg, timeout=None) — capture frame; if loopback, also enqueue for recv
|
||||
MockCANBus.recv(timeout=None) — return next injected frame (or None on timeout)
|
||||
MockCANBus.inject(arb_id, data, — queue a frame as if received from the bus
|
||||
is_extended_id=False)
|
||||
MockCANBus.get_sent_frames() — return copy of all sent frames list
|
||||
MockCANBus.reset() — clear all state
|
||||
MockCANBus.shutdown() — mark as shut down
|
||||
"""
|
||||
|
||||
import queue
|
||||
import threading
|
||||
import time
|
||||
from typing import List, Optional
|
||||
|
||||
try:
|
||||
import can
|
||||
_Message = can.Message
|
||||
except ImportError:
|
||||
# Lightweight stand-in when python-can is not installed
|
||||
class _Message: # type: ignore[no-redef]
|
||||
def __init__(
|
||||
self,
|
||||
arbitration_id: int = 0,
|
||||
data: bytes = b"",
|
||||
is_extended_id: bool = False,
|
||||
timestamp: Optional[float] = None,
|
||||
) -> None:
|
||||
self.arbitration_id = arbitration_id
|
||||
self.data = bytearray(data)
|
||||
self.is_extended_id = is_extended_id
|
||||
self.timestamp = timestamp if timestamp is not None else time.monotonic()
|
||||
|
||||
|
||||
class MockCANBus:
|
||||
"""
|
||||
Thread-safe mock CAN bus.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
loopback: bool
|
||||
When True, every frame passed to send() is also placed in the recv
|
||||
queue, simulating a loopback interface.
|
||||
filters: list[dict] or None
|
||||
Optional list of {"can_id": int, "can_mask": int} dicts. Only frames
|
||||
matching at least one filter are returned by recv(). If None, all
|
||||
frames are returned.
|
||||
"""
|
||||
|
||||
def __init__(self, loopback: bool = False, filters=None) -> None:
|
||||
self._loopback = loopback
|
||||
self._filters = filters
|
||||
self._recv_q: queue.Queue = queue.Queue()
|
||||
self._sent: List[_Message] = []
|
||||
self._sent_lock = threading.Lock()
|
||||
self._shutdown = False
|
||||
|
||||
# ------------------------------------------------------------------
|
||||
# python-can Bus interface (subset used by CanBridgeNode)
|
||||
# ------------------------------------------------------------------
|
||||
|
||||
def send(self, msg, timeout: Optional[float] = None) -> None:
|
||||
"""Record an outbound frame. If loopback is enabled, also enqueue it."""
|
||||
if self._shutdown:
|
||||
raise RuntimeError("MockCANBus is shut down")
|
||||
# Normalise to _Message so callers can pass any object with the right attrs
|
||||
with self._sent_lock:
|
||||
self._sent.append(msg)
|
||||
if self._loopback:
|
||||
self._recv_q.put(msg)
|
||||
|
||||
def recv(self, timeout: Optional[float] = None) -> Optional[_Message]:
|
||||
"""
|
||||
Return the next injected frame. Blocks up to timeout seconds.
|
||||
Returns None if nothing arrives within the timeout.
|
||||
"""
|
||||
if self._shutdown:
|
||||
return None
|
||||
try:
|
||||
return self._recv_q.get(block=True, timeout=timeout)
|
||||
except queue.Empty:
|
||||
return None
|
||||
|
||||
def shutdown(self) -> None:
|
||||
"""Mark the bus as shut down; subsequent recv() returns None."""
|
||||
self._shutdown = True
|
||||
|
||||
# ------------------------------------------------------------------
|
||||
# Test helpers
|
||||
# ------------------------------------------------------------------
|
||||
|
||||
def inject(
|
||||
self,
|
||||
arbitration_id: int,
|
||||
data: bytes,
|
||||
is_extended_id: bool = False,
|
||||
timestamp: Optional[float] = None,
|
||||
) -> None:
|
||||
"""
|
||||
Inject a frame into the receive queue as if it arrived from the bus.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arbitration_id: CAN arbitration ID
|
||||
data: frame payload bytes
|
||||
is_extended_id: True for 29-bit extended frames (VESC style)
|
||||
timestamp: optional monotonic timestamp; defaults to time.monotonic()
|
||||
"""
|
||||
msg = _Message(
|
||||
arbitration_id=arbitration_id,
|
||||
data=data,
|
||||
is_extended_id=is_extended_id,
|
||||
timestamp=timestamp if timestamp is not None else time.monotonic(),
|
||||
)
|
||||
self._recv_q.put(msg)
|
||||
|
||||
def get_sent_frames(self) -> List[_Message]:
|
||||
"""Return a snapshot of all frames sent through this bus."""
|
||||
with self._sent_lock:
|
||||
return list(self._sent)
|
||||
|
||||
def get_sent_frames_by_id(self, arbitration_id: int) -> List[_Message]:
|
||||
"""Return only sent frames whose arbitration_id matches."""
|
||||
with self._sent_lock:
|
||||
return [f for f in self._sent if f.arbitration_id == arbitration_id]
|
||||
|
||||
def reset(self) -> None:
|
||||
"""Clear all sent frames and drain the receive queue."""
|
||||
with self._sent_lock:
|
||||
self._sent.clear()
|
||||
while not self._recv_q.empty():
|
||||
try:
|
||||
self._recv_q.get_nowait()
|
||||
except queue.Empty:
|
||||
break
|
||||
self._shutdown = False
|
||||
|
||||
def pending_recv(self) -> int:
|
||||
"""Return the number of frames waiting in the receive queue."""
|
||||
return self._recv_q.qsize()
|
||||
|
||||
# ------------------------------------------------------------------
|
||||
# Context manager support
|
||||
# ------------------------------------------------------------------
|
||||
|
||||
def __enter__(self):
|
||||
return self
|
||||
|
||||
def __exit__(self, exc_type, exc_val, exc_tb):
|
||||
self.shutdown()
|
||||
return False
|
||||
@ -0,0 +1,314 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
protocol_defs.py — CAN message ID constants and frame builders/parsers for the
|
||||
Orin↔Mamba↔VESC integration test suite.
|
||||
|
||||
All IDs and payload formats are derived from:
|
||||
include/orin_can.h — Orin↔FC (Mamba) protocol
|
||||
include/vesc_can.h — VESC CAN protocol
|
||||
saltybot_can_bridge/mamba_protocol.py — existing bridge constants
|
||||
|
||||
CAN IDs used in tests
|
||||
---------------------
|
||||
Orin → FC (Mamba) commands (standard 11-bit, matching orin_can.h):
|
||||
ORIN_CMD_HEARTBEAT 0x300
|
||||
ORIN_CMD_DRIVE 0x301 int16 speed (−1000..+1000), int16 steer (−1000..+1000)
|
||||
ORIN_CMD_MODE 0x302 uint8 mode byte
|
||||
ORIN_CMD_ESTOP 0x303 uint8 action (1=ESTOP, 0=CLEAR)
|
||||
|
||||
FC (Mamba) → Orin telemetry (standard 11-bit, matching orin_can.h):
|
||||
FC_STATUS 0x400 8 bytes (see orin_can_fc_status_t)
|
||||
FC_VESC 0x401 8 bytes (see orin_can_fc_vesc_t)
|
||||
FC_IMU 0x402 8 bytes
|
||||
FC_BARO 0x403 8 bytes
|
||||
|
||||
Mamba ↔ VESC internal commands (matching mamba_protocol.py):
|
||||
MAMBA_CMD_VELOCITY 0x100 8 bytes left_mps (f32) | right_mps (f32) big-endian
|
||||
MAMBA_CMD_MODE 0x101 1 byte mode (0=idle,1=drive,2=estop)
|
||||
MAMBA_CMD_ESTOP 0x102 1 byte 0x01=stop
|
||||
|
||||
VESC STATUS (extended 29-bit, matching vesc_can.h):
|
||||
arb_id = (VESC_PKT_STATUS << 8) | vesc_node_id = (9 << 8) | node_id
|
||||
Payload: int32 RPM (BE), int16 current×10 (BE), int16 duty×1000 (BE)
|
||||
"""
|
||||
|
||||
import struct
|
||||
from typing import Tuple
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Orin → FC (Mamba) command IDs (from orin_can.h)
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
ORIN_CMD_HEARTBEAT: int = 0x300
|
||||
ORIN_CMD_DRIVE: int = 0x301
|
||||
ORIN_CMD_MODE: int = 0x302
|
||||
ORIN_CMD_ESTOP: int = 0x303
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# FC (Mamba) → Orin telemetry IDs (from orin_can.h)
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
FC_STATUS: int = 0x400
|
||||
FC_VESC: int = 0x401
|
||||
FC_IMU: int = 0x402
|
||||
FC_BARO: int = 0x403
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Mamba → VESC internal command IDs (from mamba_protocol.py)
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
MAMBA_CMD_VELOCITY: int = 0x100
|
||||
MAMBA_CMD_MODE: int = 0x101
|
||||
MAMBA_CMD_ESTOP: int = 0x102
|
||||
|
||||
MAMBA_TELEM_IMU: int = 0x200
|
||||
MAMBA_TELEM_BATTERY: int = 0x201
|
||||
VESC_TELEM_STATE: int = 0x300
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Mode constants
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
MODE_IDLE: int = 0
|
||||
MODE_DRIVE: int = 1
|
||||
MODE_ESTOP: int = 2
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# VESC protocol constants (from vesc_can.h)
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
VESC_PKT_STATUS: int = 9 # STATUS packet type (upper byte of arb_id)
|
||||
VESC_PKT_SET_RPM: int = 3 # SET_RPM packet type
|
||||
|
||||
VESC_CAN_ID_LEFT: int = 56
|
||||
VESC_CAN_ID_RIGHT: int = 68
|
||||
|
||||
|
||||
def VESC_STATUS_ID(vesc_node_id: int) -> int:
|
||||
"""
|
||||
Return the 29-bit extended arbitration ID for a VESC STATUS frame.
|
||||
|
||||
Formula (from vesc_can.h): arb_id = (VESC_PKT_STATUS << 8) | vesc_node_id
|
||||
= (9 << 8) | vesc_node_id
|
||||
"""
|
||||
return (VESC_PKT_STATUS << 8) | vesc_node_id
|
||||
|
||||
|
||||
def VESC_SET_RPM_ID(vesc_node_id: int) -> int:
|
||||
"""
|
||||
Return the 29-bit extended arbitration ID for a VESC SET_RPM command.
|
||||
|
||||
Formula: arb_id = (VESC_PKT_SET_RPM << 8) | vesc_node_id
|
||||
= (3 << 8) | vesc_node_id
|
||||
"""
|
||||
return (VESC_PKT_SET_RPM << 8) | vesc_node_id
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Frame builders — Orin → FC
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def build_heartbeat(seq: int = 0) -> bytes:
|
||||
"""Build a HEARTBEAT payload: uint32 sequence counter (big-endian, 4 bytes)."""
|
||||
return struct.pack(">I", seq & 0xFFFFFFFF)
|
||||
|
||||
|
||||
def build_drive_cmd(speed: int, steer: int) -> bytes:
|
||||
"""
|
||||
Build an ORIN_CMD_DRIVE payload.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
speed: int, −1000..+1000 (mapped directly to int16)
|
||||
steer: int, −1000..+1000
|
||||
"""
|
||||
return struct.pack(">hh", int(speed), int(steer))
|
||||
|
||||
|
||||
def build_mode_cmd(mode: int) -> bytes:
|
||||
"""Build an ORIN_CMD_MODE payload (1 byte)."""
|
||||
return struct.pack(">B", mode & 0xFF)
|
||||
|
||||
|
||||
def build_estop_cmd(action: int = 1) -> bytes:
|
||||
"""Build an ORIN_CMD_ESTOP payload. action=1 → ESTOP, 0 → CLEAR."""
|
||||
return struct.pack(">B", action & 0xFF)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Frame builders — Mamba velocity commands (mamba_protocol.py encoding)
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def build_velocity_cmd(left_mps: float, right_mps: float) -> bytes:
|
||||
"""
|
||||
Build a MAMBA_CMD_VELOCITY payload (8 bytes, 2 × float32 big-endian).
|
||||
|
||||
Matches encode_velocity_cmd() in mamba_protocol.py.
|
||||
"""
|
||||
return struct.pack(">ff", float(left_mps), float(right_mps))
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Frame builders — FC → Orin telemetry
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def build_fc_status(
|
||||
pitch_x10: int = 0,
|
||||
motor_cmd: int = 0,
|
||||
vbat_mv: int = 24000,
|
||||
balance_state: int = 1,
|
||||
flags: int = 0,
|
||||
) -> bytes:
|
||||
"""
|
||||
Build an FC_STATUS (0x400) payload.
|
||||
|
||||
Layout (orin_can_fc_status_t, 8 bytes, big-endian):
|
||||
int16 pitch_x10
|
||||
int16 motor_cmd
|
||||
uint16 vbat_mv
|
||||
uint8 balance_state
|
||||
uint8 flags [bit0=estop_active, bit1=armed]
|
||||
"""
|
||||
return struct.pack(
|
||||
">hhHBB",
|
||||
int(pitch_x10),
|
||||
int(motor_cmd),
|
||||
int(vbat_mv) & 0xFFFF,
|
||||
int(balance_state) & 0xFF,
|
||||
int(flags) & 0xFF,
|
||||
)
|
||||
|
||||
|
||||
def build_fc_vesc(
|
||||
left_rpm_x10: int = 0,
|
||||
right_rpm_x10: int = 0,
|
||||
left_current_x10: int = 0,
|
||||
right_current_x10: int = 0,
|
||||
) -> bytes:
|
||||
"""
|
||||
Build an FC_VESC (0x401) payload.
|
||||
|
||||
Layout (orin_can_fc_vesc_t, 8 bytes, big-endian):
|
||||
int16 left_rpm_x10
|
||||
int16 right_rpm_x10
|
||||
int16 left_current_x10
|
||||
int16 right_current_x10
|
||||
|
||||
RPM values are RPM / 10 (e.g. 3000 RPM → 300).
|
||||
Current values are A × 10 (e.g. 5.5 A → 55).
|
||||
"""
|
||||
return struct.pack(
|
||||
">hhhh",
|
||||
int(left_rpm_x10),
|
||||
int(right_rpm_x10),
|
||||
int(left_current_x10),
|
||||
int(right_current_x10),
|
||||
)
|
||||
|
||||
|
||||
def build_vesc_status(
|
||||
rpm: int = 0,
|
||||
current_x10: int = 0,
|
||||
duty_x1000: int = 0,
|
||||
) -> bytes:
|
||||
"""
|
||||
Build a VESC STATUS (packet type 9) payload.
|
||||
|
||||
Layout (from vesc_can.h / VESC FW 6.x, big-endian):
|
||||
int32 rpm
|
||||
int16 current × 10
|
||||
int16 duty × 1000
|
||||
Total: 8 bytes.
|
||||
"""
|
||||
return struct.pack(
|
||||
">ihh",
|
||||
int(rpm),
|
||||
int(current_x10),
|
||||
int(duty_x1000),
|
||||
)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Frame parsers
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def parse_fc_status(data: bytes):
|
||||
"""
|
||||
Parse an FC_STATUS (0x400) payload.
|
||||
|
||||
Returns
|
||||
-------
|
||||
dict with keys: pitch_x10, motor_cmd, vbat_mv, balance_state, flags,
|
||||
estop_active (bool), armed (bool)
|
||||
"""
|
||||
if len(data) < 8:
|
||||
raise ValueError(f"FC_STATUS needs 8 bytes, got {len(data)}")
|
||||
pitch_x10, motor_cmd, vbat_mv, balance_state, flags = struct.unpack(
|
||||
">hhHBB", data[:8]
|
||||
)
|
||||
return {
|
||||
"pitch_x10": pitch_x10,
|
||||
"motor_cmd": motor_cmd,
|
||||
"vbat_mv": vbat_mv,
|
||||
"balance_state": balance_state,
|
||||
"flags": flags,
|
||||
"estop_active": bool(flags & 0x01),
|
||||
"armed": bool(flags & 0x02),
|
||||
}
|
||||
|
||||
|
||||
def parse_fc_vesc(data: bytes):
|
||||
"""
|
||||
Parse an FC_VESC (0x401) payload.
|
||||
|
||||
Returns
|
||||
-------
|
||||
dict with keys: left_rpm_x10, right_rpm_x10, left_current_x10,
|
||||
right_current_x10, left_rpm (float), right_rpm (float)
|
||||
"""
|
||||
if len(data) < 8:
|
||||
raise ValueError(f"FC_VESC needs 8 bytes, got {len(data)}")
|
||||
left_rpm_x10, right_rpm_x10, left_cur_x10, right_cur_x10 = struct.unpack(
|
||||
">hhhh", data[:8]
|
||||
)
|
||||
return {
|
||||
"left_rpm_x10": left_rpm_x10,
|
||||
"right_rpm_x10": right_rpm_x10,
|
||||
"left_current_x10": left_cur_x10,
|
||||
"right_current_x10": right_cur_x10,
|
||||
"left_rpm": left_rpm_x10 * 10.0,
|
||||
"right_rpm": right_rpm_x10 * 10.0,
|
||||
}
|
||||
|
||||
|
||||
def parse_vesc_status(data: bytes):
|
||||
"""
|
||||
Parse a VESC STATUS (packet type 9) payload.
|
||||
|
||||
Returns
|
||||
-------
|
||||
dict with keys: rpm, current_x10, duty_x1000, current (float), duty (float)
|
||||
"""
|
||||
if len(data) < 8:
|
||||
raise ValueError(f"VESC STATUS needs 8 bytes, got {len(data)}")
|
||||
rpm, current_x10, duty_x1000 = struct.unpack(">ihh", data[:8])
|
||||
return {
|
||||
"rpm": rpm,
|
||||
"current_x10": current_x10,
|
||||
"duty_x1000": duty_x1000,
|
||||
"current": current_x10 / 10.0,
|
||||
"duty": duty_x1000 / 1000.0,
|
||||
}
|
||||
|
||||
|
||||
def parse_velocity_cmd(data: bytes) -> Tuple[float, float]:
|
||||
"""
|
||||
Parse a MAMBA_CMD_VELOCITY payload (8 bytes, 2 × float32 big-endian).
|
||||
|
||||
Returns
|
||||
-------
|
||||
(left_mps, right_mps)
|
||||
"""
|
||||
if len(data) < 8:
|
||||
raise ValueError(f"MAMBA_CMD_VELOCITY needs 8 bytes, got {len(data)}")
|
||||
return struct.unpack(">ff", data[:8])
|
||||
5
jetson/ros2_ws/src/saltybot_can_e2e_test/setup.cfg
Normal file
5
jetson/ros2_ws/src/saltybot_can_e2e_test/setup.cfg
Normal file
@ -0,0 +1,5 @@
|
||||
[develop]
|
||||
script_dir=$base/lib/saltybot_can_e2e_test
|
||||
|
||||
[install]
|
||||
install_scripts=$base/lib/saltybot_can_e2e_test
|
||||
23
jetson/ros2_ws/src/saltybot_can_e2e_test/setup.py
Normal file
23
jetson/ros2_ws/src/saltybot_can_e2e_test/setup.py
Normal file
@ -0,0 +1,23 @@
|
||||
from setuptools import setup
|
||||
|
||||
package_name = "saltybot_can_e2e_test"
|
||||
|
||||
setup(
|
||||
name=package_name,
|
||||
version="0.1.0",
|
||||
packages=[package_name],
|
||||
data_files=[
|
||||
("share/ament_index/resource_index/packages", [f"resource/{package_name}"]),
|
||||
(f"share/{package_name}", ["package.xml"]),
|
||||
],
|
||||
install_requires=["setuptools"],
|
||||
zip_safe=True,
|
||||
maintainer="sl-jetson",
|
||||
maintainer_email="sl-jetson@saltylab.local",
|
||||
description="End-to-end CAN integration tests for Orin↔Mamba↔VESC full loop",
|
||||
license="MIT",
|
||||
tests_require=["pytest"],
|
||||
entry_points={
|
||||
"console_scripts": [],
|
||||
},
|
||||
)
|
||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
93
jetson/ros2_ws/src/saltybot_can_e2e_test/test/conftest.py
Normal file
93
jetson/ros2_ws/src/saltybot_can_e2e_test/test/conftest.py
Normal file
@ -0,0 +1,93 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
conftest.py — pytest fixtures for the saltybot_can_e2e_test suite.
|
||||
|
||||
No ROS2 node infrastructure is started; all tests run purely in Python.
|
||||
"""
|
||||
|
||||
import sys
|
||||
import os
|
||||
|
||||
# Ensure the package root is on sys.path so relative imports work when running
|
||||
# pytest directly from the saltybot_can_e2e_test/ directory.
|
||||
_pkg_root = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
|
||||
if _pkg_root not in sys.path:
|
||||
sys.path.insert(0, _pkg_root)
|
||||
|
||||
# Also add the saltybot_can_bridge package so we can import mamba_protocol.
|
||||
_bridge_pkg = os.path.join(
|
||||
os.path.dirname(_pkg_root), "saltybot_can_bridge"
|
||||
)
|
||||
if _bridge_pkg not in sys.path:
|
||||
sys.path.insert(0, _bridge_pkg)
|
||||
|
||||
import pytest
|
||||
|
||||
from saltybot_can_e2e_test.can_mock import MockCANBus
|
||||
from saltybot_can_e2e_test.protocol_defs import (
|
||||
VESC_CAN_ID_LEFT,
|
||||
VESC_CAN_ID_RIGHT,
|
||||
)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Core fixtures
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
@pytest.fixture(scope="function")
|
||||
def mock_can_bus():
|
||||
"""
|
||||
Provide a fresh MockCANBus instance per test function.
|
||||
The bus is automatically shut down after each test.
|
||||
"""
|
||||
bus = MockCANBus(loopback=False)
|
||||
yield bus
|
||||
bus.shutdown()
|
||||
|
||||
|
||||
@pytest.fixture(scope="function")
|
||||
def loopback_can_bus():
|
||||
"""
|
||||
MockCANBus in loopback mode — sent frames are also queued for recv.
|
||||
Useful for testing round-trip behaviour without a second node.
|
||||
"""
|
||||
bus = MockCANBus(loopback=True)
|
||||
yield bus
|
||||
bus.shutdown()
|
||||
|
||||
|
||||
@pytest.fixture(scope="function")
|
||||
def bridge_components():
|
||||
"""
|
||||
Return the mamba_protocol encode/decode callables and a fresh mock bus.
|
||||
|
||||
Yields a dict with keys:
|
||||
bus — MockCANBus instance
|
||||
encode_vel — encode_velocity_cmd(left, right) → bytes
|
||||
encode_mode — encode_mode_cmd(mode) → bytes
|
||||
encode_estop — encode_estop_cmd(stop) → bytes
|
||||
decode_vesc — decode_vesc_state(data) → VescStateTelemetry
|
||||
"""
|
||||
from saltybot_can_bridge.mamba_protocol import (
|
||||
encode_velocity_cmd,
|
||||
encode_mode_cmd,
|
||||
encode_estop_cmd,
|
||||
decode_vesc_state,
|
||||
decode_battery_telem,
|
||||
decode_imu_telem,
|
||||
)
|
||||
|
||||
bus = MockCANBus(loopback=False)
|
||||
yield {
|
||||
"bus": bus,
|
||||
"encode_vel": encode_velocity_cmd,
|
||||
"encode_mode": encode_mode_cmd,
|
||||
"encode_estop": encode_estop_cmd,
|
||||
"decode_vesc": decode_vesc_state,
|
||||
"decode_battery": decode_battery_telem,
|
||||
"decode_imu": decode_imu_telem,
|
||||
"left_vesc_id": VESC_CAN_ID_LEFT,
|
||||
"right_vesc_id": VESC_CAN_ID_RIGHT,
|
||||
}
|
||||
bus.shutdown()
|
||||
@ -0,0 +1,193 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
test_drive_command.py — Integration tests for the drive command path.
|
||||
|
||||
Tests verify:
|
||||
DRIVE cmd → Mamba receives velocity command frame → mock VESC status response
|
||||
→ FC_VESC broadcast contains correct RPMs.
|
||||
|
||||
All tests run without real hardware or a running ROS2 system.
|
||||
Run with: python -m pytest test/test_drive_command.py -v
|
||||
"""
|
||||
|
||||
import struct
|
||||
import pytest
|
||||
|
||||
from saltybot_can_e2e_test.protocol_defs import (
|
||||
MAMBA_CMD_VELOCITY,
|
||||
MAMBA_CMD_MODE,
|
||||
FC_VESC,
|
||||
MODE_DRIVE,
|
||||
MODE_IDLE,
|
||||
VESC_CAN_ID_LEFT,
|
||||
VESC_CAN_ID_RIGHT,
|
||||
VESC_STATUS_ID,
|
||||
build_velocity_cmd,
|
||||
build_fc_vesc,
|
||||
build_vesc_status,
|
||||
parse_velocity_cmd,
|
||||
parse_fc_vesc,
|
||||
)
|
||||
from saltybot_can_bridge.mamba_protocol import (
|
||||
encode_velocity_cmd,
|
||||
encode_mode_cmd,
|
||||
)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Helper
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def _send_drive(bus, left_mps: float, right_mps: float) -> None:
|
||||
"""Simulate the bridge encoding and sending a velocity command."""
|
||||
from saltybot_can_e2e_test.can_mock import MockCANBus
|
||||
|
||||
payload = encode_velocity_cmd(left_mps, right_mps)
|
||||
# Create a minimal message object compatible with our mock
|
||||
class _Msg:
|
||||
def __init__(self, arb_id, data):
|
||||
self.arbitration_id = arb_id
|
||||
self.data = bytearray(data)
|
||||
self.is_extended_id = False
|
||||
|
||||
bus.send(_Msg(MAMBA_CMD_VELOCITY, payload))
|
||||
bus.send(_Msg(MAMBA_CMD_MODE, encode_mode_cmd(MODE_DRIVE)))
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Tests
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
class TestDriveForward:
|
||||
def test_drive_forward_velocity_frame_sent(self, mock_can_bus):
|
||||
"""
|
||||
Inject DRIVE cmd (1.0 m/s, 1.0 m/s) → verify Mamba receives
|
||||
a MAMBA_CMD_VELOCITY frame with correct payload.
|
||||
"""
|
||||
_send_drive(mock_can_bus, 1.0, 1.0)
|
||||
|
||||
vel_frames = mock_can_bus.get_sent_frames_by_id(MAMBA_CMD_VELOCITY)
|
||||
assert len(vel_frames) == 1, "Expected exactly one velocity command frame"
|
||||
|
||||
left, right = parse_velocity_cmd(bytes(vel_frames[0].data))
|
||||
assert abs(left - 1.0) < 1e-4, f"Left speed {left} != 1.0"
|
||||
assert abs(right - 1.0) < 1e-4, f"Right speed {right} != 1.0"
|
||||
|
||||
def test_drive_forward_mode_drive_sent(self, mock_can_bus):
|
||||
"""After a drive command, a MODE=drive frame must accompany it."""
|
||||
_send_drive(mock_can_bus, 1.0, 1.0)
|
||||
|
||||
mode_frames = mock_can_bus.get_sent_frames_by_id(MAMBA_CMD_MODE)
|
||||
assert len(mode_frames) >= 1, "Expected at least one MODE frame"
|
||||
assert bytes(mode_frames[0].data) == bytes([MODE_DRIVE])
|
||||
|
||||
def test_drive_forward_fc_vesc_broadcast(self, mock_can_bus):
|
||||
"""
|
||||
Simulate FC_VESC broadcast arriving after drive cmd; verify parse is correct.
|
||||
(In the real loop Mamba computes RPM from m/s and broadcasts FC_VESC.)
|
||||
This test checks the FC_VESC frame format and parser.
|
||||
"""
|
||||
# Simulate: 1.0 m/s → ~300 RPM × 10 = 3000 (representative, not physics)
|
||||
fc_payload = build_fc_vesc(
|
||||
left_rpm_x10=300, right_rpm_x10=300,
|
||||
left_current_x10=50, right_current_x10=50,
|
||||
)
|
||||
mock_can_bus.inject(FC_VESC, fc_payload)
|
||||
|
||||
frame = mock_can_bus.recv(timeout=0.1)
|
||||
assert frame is not None, "FC_VESC frame not received"
|
||||
parsed = parse_fc_vesc(bytes(frame.data))
|
||||
assert parsed["left_rpm_x10"] == 300
|
||||
assert parsed["right_rpm_x10"] == 300
|
||||
assert abs(parsed["left_rpm"] - 3000.0) < 0.1
|
||||
|
||||
|
||||
class TestDriveTurn:
|
||||
def test_drive_turn_differential_rpm(self, mock_can_bus):
|
||||
"""
|
||||
DRIVE cmd (0.5, −0.5) → verify differential RPM in velocity command.
|
||||
"""
|
||||
_send_drive(mock_can_bus, 0.5, -0.5)
|
||||
|
||||
vel_frames = mock_can_bus.get_sent_frames_by_id(MAMBA_CMD_VELOCITY)
|
||||
assert len(vel_frames) == 1
|
||||
|
||||
left, right = parse_velocity_cmd(bytes(vel_frames[0].data))
|
||||
assert abs(left - 0.5) < 1e-4, f"Left speed {left} != 0.5"
|
||||
assert abs(right - (-0.5)) < 1e-4, f"Right speed {right} != -0.5"
|
||||
# Signs must be opposite for a zero-radius spin
|
||||
assert left > 0 and right < 0
|
||||
|
||||
def test_drive_turn_fc_vesc_differential(self, mock_can_bus):
|
||||
"""Simulated FC_VESC for a turn has opposite-sign RPMs."""
|
||||
fc_payload = build_fc_vesc(
|
||||
left_rpm_x10=150, right_rpm_x10=-150,
|
||||
left_current_x10=30, right_current_x10=30,
|
||||
)
|
||||
mock_can_bus.inject(FC_VESC, fc_payload)
|
||||
frame = mock_can_bus.recv(timeout=0.1)
|
||||
parsed = parse_fc_vesc(bytes(frame.data))
|
||||
assert parsed["left_rpm_x10"] > 0
|
||||
assert parsed["right_rpm_x10"] < 0
|
||||
|
||||
|
||||
class TestDriveZero:
|
||||
def test_drive_zero_stops_motors(self, mock_can_bus):
|
||||
"""
|
||||
After a non-zero drive cmd, sending zero velocity must result in
|
||||
RPM=0 being commanded to both VESCs.
|
||||
"""
|
||||
_send_drive(mock_can_bus, 1.0, 1.0)
|
||||
mock_can_bus.reset() # clear prior frames
|
||||
|
||||
_send_drive(mock_can_bus, 0.0, 0.0)
|
||||
|
||||
vel_frames = mock_can_bus.get_sent_frames_by_id(MAMBA_CMD_VELOCITY)
|
||||
assert len(vel_frames) == 1
|
||||
left, right = parse_velocity_cmd(bytes(vel_frames[0].data))
|
||||
assert abs(left) < 1e-5, "Left motor not stopped"
|
||||
assert abs(right) < 1e-5, "Right motor not stopped"
|
||||
|
||||
|
||||
class TestDriveCmdTimeout:
|
||||
def test_drive_cmd_timeout_sends_zero(self, mock_can_bus):
|
||||
"""
|
||||
Simulate the watchdog behaviour: if no DRIVE cmd arrives for >500 ms,
|
||||
zero velocity is sent. We test the encoding directly (without timers).
|
||||
"""
|
||||
# The watchdog in CanBridgeNode calls encode_velocity_cmd(0.0, 0.0) and
|
||||
# sends it on MAMBA_CMD_VELOCITY. Replicate that here.
|
||||
zero_payload = encode_velocity_cmd(0.0, 0.0)
|
||||
|
||||
class _Msg:
|
||||
def __init__(self, arb_id, data):
|
||||
self.arbitration_id = arb_id
|
||||
self.data = bytearray(data)
|
||||
self.is_extended_id = False
|
||||
|
||||
mock_can_bus.send(_Msg(MAMBA_CMD_VELOCITY, zero_payload))
|
||||
mock_can_bus.send(_Msg(MAMBA_CMD_MODE, encode_mode_cmd(MODE_IDLE)))
|
||||
|
||||
vel_frames = mock_can_bus.get_sent_frames_by_id(MAMBA_CMD_VELOCITY)
|
||||
assert len(vel_frames) == 1
|
||||
left, right = parse_velocity_cmd(bytes(vel_frames[0].data))
|
||||
assert abs(left) < 1e-5
|
||||
assert abs(right) < 1e-5
|
||||
|
||||
mode_frames = mock_can_bus.get_sent_frames_by_id(MAMBA_CMD_MODE)
|
||||
assert len(mode_frames) == 1
|
||||
assert bytes(mode_frames[0].data) == bytes([MODE_IDLE])
|
||||
|
||||
|
||||
@pytest.mark.parametrize("left_mps,right_mps", [
|
||||
(0.5, 0.5),
|
||||
(1.0, 0.0),
|
||||
(0.0, -1.0),
|
||||
(-0.5, -0.5),
|
||||
])
|
||||
def test_drive_cmd_payload_roundtrip(mock_can_bus, left_mps, right_mps):
|
||||
"""Parametrized: encode then decode must recover original velocities."""
|
||||
payload = encode_velocity_cmd(left_mps, right_mps)
|
||||
l, r = parse_velocity_cmd(payload)
|
||||
assert abs(l - left_mps) < 1e-4
|
||||
assert abs(r - right_mps) < 1e-4
|
||||
264
jetson/ros2_ws/src/saltybot_can_e2e_test/test/test_estop.py
Normal file
264
jetson/ros2_ws/src/saltybot_can_e2e_test/test/test_estop.py
Normal file
@ -0,0 +1,264 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
test_estop.py — E-stop command integration tests.
|
||||
|
||||
Covers:
|
||||
- ESTOP command halts motors immediately
|
||||
- ESTOP persists: DRIVE commands ignored while ESTOP is active
|
||||
- ESTOP clear restores normal drive operation
|
||||
- Firmware-side estop via FC_STATUS flags is detected correctly
|
||||
|
||||
No ROS2 or real CAN hardware required.
|
||||
Run with: python -m pytest test/test_estop.py -v
|
||||
"""
|
||||
|
||||
import struct
|
||||
import pytest
|
||||
|
||||
from saltybot_can_e2e_test.can_mock import MockCANBus
|
||||
from saltybot_can_e2e_test.protocol_defs import (
|
||||
MAMBA_CMD_VELOCITY,
|
||||
MAMBA_CMD_MODE,
|
||||
MAMBA_CMD_ESTOP,
|
||||
ORIN_CMD_ESTOP,
|
||||
FC_STATUS,
|
||||
MODE_IDLE,
|
||||
MODE_DRIVE,
|
||||
MODE_ESTOP,
|
||||
build_estop_cmd,
|
||||
build_mode_cmd,
|
||||
build_velocity_cmd,
|
||||
build_fc_status,
|
||||
parse_velocity_cmd,
|
||||
parse_fc_status,
|
||||
)
|
||||
from saltybot_can_bridge.mamba_protocol import (
|
||||
encode_velocity_cmd,
|
||||
encode_mode_cmd,
|
||||
encode_estop_cmd,
|
||||
)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Helpers
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
class _Msg:
|
||||
"""Minimal CAN message stand-in."""
|
||||
def __init__(self, arb_id: int, data: bytes, is_extended_id: bool = False):
|
||||
self.arbitration_id = arb_id
|
||||
self.data = bytearray(data)
|
||||
self.is_extended_id = is_extended_id
|
||||
|
||||
|
||||
class EstopStateMachine:
|
||||
"""
|
||||
Lightweight state machine that mirrors the bridge estop logic.
|
||||
|
||||
Tracks whether ESTOP is active and gates velocity commands accordingly.
|
||||
Sends frames to the supplied MockCANBus.
|
||||
"""
|
||||
|
||||
def __init__(self, bus: MockCANBus):
|
||||
self._bus = bus
|
||||
self._estop_active = False
|
||||
self._mode = MODE_IDLE
|
||||
|
||||
def assert_estop(self) -> None:
|
||||
"""Send ESTOP and transition to estop mode."""
|
||||
self._estop_active = True
|
||||
self._mode = MODE_ESTOP
|
||||
self._bus.send(_Msg(MAMBA_CMD_VELOCITY, encode_velocity_cmd(0.0, 0.0)))
|
||||
self._bus.send(_Msg(MAMBA_CMD_MODE, encode_mode_cmd(MODE_ESTOP)))
|
||||
self._bus.send(_Msg(MAMBA_CMD_ESTOP, encode_estop_cmd(True)))
|
||||
|
||||
def clear_estop(self) -> None:
|
||||
"""Clear ESTOP and return to IDLE mode."""
|
||||
self._estop_active = False
|
||||
self._mode = MODE_IDLE
|
||||
self._bus.send(_Msg(MAMBA_CMD_ESTOP, encode_estop_cmd(False)))
|
||||
self._bus.send(_Msg(MAMBA_CMD_MODE, encode_mode_cmd(MODE_IDLE)))
|
||||
|
||||
def send_drive(self, left_mps: float, right_mps: float) -> None:
|
||||
"""Send velocity command only if ESTOP is not active."""
|
||||
if self._estop_active:
|
||||
# Bridge silently drops commands while estopped
|
||||
return
|
||||
self._mode = MODE_DRIVE
|
||||
self._bus.send(_Msg(MAMBA_CMD_VELOCITY, encode_velocity_cmd(left_mps, right_mps)))
|
||||
self._bus.send(_Msg(MAMBA_CMD_MODE, encode_mode_cmd(MODE_DRIVE)))
|
||||
|
||||
@property
|
||||
def estop_active(self) -> bool:
|
||||
return self._estop_active
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Tests
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
class TestEstopHaltsMotors:
|
||||
def test_estop_command_halts_motors(self, mock_can_bus):
|
||||
"""
|
||||
After injecting ESTOP, zero velocity must be commanded immediately.
|
||||
"""
|
||||
sm = EstopStateMachine(mock_can_bus)
|
||||
sm.assert_estop()
|
||||
|
||||
vel_frames = mock_can_bus.get_sent_frames_by_id(MAMBA_CMD_VELOCITY)
|
||||
assert len(vel_frames) >= 1, "No velocity frame after ESTOP"
|
||||
l, r = parse_velocity_cmd(bytes(vel_frames[-1].data))
|
||||
assert abs(l) < 1e-5, f"Left motor {l} not zero after ESTOP"
|
||||
assert abs(r) < 1e-5, f"Right motor {r} not zero after ESTOP"
|
||||
|
||||
def test_estop_mode_frame_sent(self, mock_can_bus):
|
||||
"""ESTOP mode byte must be broadcast on CAN."""
|
||||
sm = EstopStateMachine(mock_can_bus)
|
||||
sm.assert_estop()
|
||||
|
||||
mode_frames = mock_can_bus.get_sent_frames_by_id(MAMBA_CMD_MODE)
|
||||
assert any(
|
||||
bytes(f.data) == bytes([MODE_ESTOP]) for f in mode_frames
|
||||
), "MODE=ESTOP not found in sent frames"
|
||||
|
||||
def test_estop_flag_byte_is_0x01(self, mock_can_bus):
|
||||
"""MAMBA_CMD_ESTOP payload must be 0x01 when asserting e-stop."""
|
||||
sm = EstopStateMachine(mock_can_bus)
|
||||
sm.assert_estop()
|
||||
|
||||
estop_frames = mock_can_bus.get_sent_frames_by_id(MAMBA_CMD_ESTOP)
|
||||
assert len(estop_frames) >= 1
|
||||
assert bytes(estop_frames[-1].data) == b"\x01", \
|
||||
f"ESTOP payload {estop_frames[-1].data!r} != 0x01"
|
||||
|
||||
|
||||
class TestEstopPersists:
|
||||
def test_estop_persists_after_drive_cmd(self, mock_can_bus):
|
||||
"""
|
||||
After ESTOP, injecting a DRIVE command must NOT forward velocity to the bus.
|
||||
"""
|
||||
sm = EstopStateMachine(mock_can_bus)
|
||||
sm.assert_estop()
|
||||
mock_can_bus.reset() # start fresh after initial ESTOP frames
|
||||
|
||||
sm.send_drive(1.0, 1.0) # should be suppressed
|
||||
|
||||
vel_frames = mock_can_bus.get_sent_frames_by_id(MAMBA_CMD_VELOCITY)
|
||||
assert len(vel_frames) == 0, \
|
||||
"Velocity command was forwarded while ESTOP is active"
|
||||
|
||||
def test_estop_mode_unchanged_after_drive_attempt(self, mock_can_bus):
|
||||
"""
|
||||
After ESTOP, attempting DRIVE must not change the mode to DRIVE.
|
||||
"""
|
||||
sm = EstopStateMachine(mock_can_bus)
|
||||
sm.assert_estop()
|
||||
mock_can_bus.reset()
|
||||
|
||||
sm.send_drive(0.5, 0.5)
|
||||
|
||||
# No mode frames should have been emitted (drive was suppressed)
|
||||
mode_frames = mock_can_bus.get_sent_frames_by_id(MAMBA_CMD_MODE)
|
||||
assert all(
|
||||
bytes(f.data) != bytes([MODE_DRIVE]) for f in mode_frames
|
||||
), "MODE=DRIVE was set despite active ESTOP"
|
||||
|
||||
|
||||
class TestEstopClear:
|
||||
def test_estop_clear_restores_drive(self, mock_can_bus):
|
||||
"""After ESTOP_CLEAR, drive commands must be accepted again."""
|
||||
sm = EstopStateMachine(mock_can_bus)
|
||||
sm.assert_estop()
|
||||
sm.clear_estop()
|
||||
mock_can_bus.reset()
|
||||
|
||||
sm.send_drive(0.8, 0.8)
|
||||
|
||||
vel_frames = mock_can_bus.get_sent_frames_by_id(MAMBA_CMD_VELOCITY)
|
||||
assert len(vel_frames) == 1, "Velocity command not sent after ESTOP clear"
|
||||
l, r = parse_velocity_cmd(bytes(vel_frames[0].data))
|
||||
assert abs(l - 0.8) < 1e-4
|
||||
assert abs(r - 0.8) < 1e-4
|
||||
|
||||
def test_estop_clear_flag_byte_is_0x00(self, mock_can_bus):
|
||||
"""MAMBA_CMD_ESTOP payload must be 0x00 when clearing e-stop."""
|
||||
sm = EstopStateMachine(mock_can_bus)
|
||||
sm.assert_estop()
|
||||
sm.clear_estop()
|
||||
|
||||
estop_frames = mock_can_bus.get_sent_frames_by_id(MAMBA_CMD_ESTOP)
|
||||
assert len(estop_frames) >= 2
|
||||
# Last ESTOP frame should be the clear
|
||||
assert bytes(estop_frames[-1].data) == b"\x00", \
|
||||
f"ESTOP clear payload {estop_frames[-1].data!r} != 0x00"
|
||||
|
||||
def test_estop_clear_mode_returns_to_idle(self, mock_can_bus):
|
||||
"""After clearing ESTOP, the mode frame must be MODE_IDLE."""
|
||||
sm = EstopStateMachine(mock_can_bus)
|
||||
sm.assert_estop()
|
||||
sm.clear_estop()
|
||||
|
||||
mode_frames = mock_can_bus.get_sent_frames_by_id(MAMBA_CMD_MODE)
|
||||
last_mode = bytes(mode_frames[-1].data)
|
||||
assert last_mode == bytes([MODE_IDLE]), \
|
||||
f"Mode after ESTOP clear is {last_mode!r}, expected MODE_IDLE"
|
||||
|
||||
|
||||
class TestFirmwareSideEstop:
|
||||
def test_fc_status_estop_flag_detected(self, mock_can_bus):
|
||||
"""
|
||||
Simulate firmware sending estop via FC_STATUS flags (bit0=estop_active).
|
||||
Verify the Orin bridge side correctly parses the flag.
|
||||
"""
|
||||
# Build FC_STATUS with estop_active bit set (flags=0x01)
|
||||
payload = build_fc_status(
|
||||
pitch_x10=0,
|
||||
motor_cmd=0,
|
||||
vbat_mv=24000,
|
||||
balance_state=2, # TILT_FAULT
|
||||
flags=0x01, # bit0 = estop_active
|
||||
)
|
||||
mock_can_bus.inject(FC_STATUS, payload)
|
||||
|
||||
frame = mock_can_bus.recv(timeout=0.1)
|
||||
assert frame is not None, "FC_STATUS frame not received"
|
||||
parsed = parse_fc_status(bytes(frame.data))
|
||||
assert parsed["estop_active"] is True, \
|
||||
"estop_active flag not set in FC_STATUS"
|
||||
assert parsed["balance_state"] == 2
|
||||
|
||||
def test_fc_status_no_estop_flag(self, mock_can_bus):
|
||||
"""FC_STATUS with flags=0x00 must NOT set estop_active."""
|
||||
payload = build_fc_status(flags=0x00)
|
||||
mock_can_bus.inject(FC_STATUS, payload)
|
||||
frame = mock_can_bus.recv(timeout=0.1)
|
||||
parsed = parse_fc_status(bytes(frame.data))
|
||||
assert parsed["estop_active"] is False
|
||||
|
||||
def test_fc_status_armed_flag_detected(self, mock_can_bus):
|
||||
"""FC_STATUS flags bit1=armed must parse correctly."""
|
||||
payload = build_fc_status(flags=0x02) # bit1 = armed
|
||||
mock_can_bus.inject(FC_STATUS, payload)
|
||||
frame = mock_can_bus.recv(timeout=0.1)
|
||||
parsed = parse_fc_status(bytes(frame.data))
|
||||
assert parsed["armed"] is True
|
||||
assert parsed["estop_active"] is False
|
||||
|
||||
def test_fc_status_roundtrip(self, mock_can_bus):
|
||||
"""build_fc_status → inject → recv → parse_fc_status must be identity."""
|
||||
payload = build_fc_status(
|
||||
pitch_x10=150,
|
||||
motor_cmd=-200,
|
||||
vbat_mv=23800,
|
||||
balance_state=1,
|
||||
flags=0x03,
|
||||
)
|
||||
mock_can_bus.inject(FC_STATUS, payload)
|
||||
frame = mock_can_bus.recv(timeout=0.1)
|
||||
parsed = parse_fc_status(bytes(frame.data))
|
||||
assert parsed["pitch_x10"] == 150
|
||||
assert parsed["motor_cmd"] == -200
|
||||
assert parsed["vbat_mv"] == 23800
|
||||
assert parsed["balance_state"] == 1
|
||||
assert parsed["estop_active"] is True
|
||||
assert parsed["armed"] is True
|
||||
@ -0,0 +1,315 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
test_fc_vesc_broadcast.py — FC_VESC broadcast and VESC STATUS integration tests.
|
||||
|
||||
Covers:
|
||||
- VESC STATUS extended frame for left VESC (ID 56) triggers FC_VESC broadcast
|
||||
- Both left (56) and right (68) VESC STATUS combined in FC_VESC
|
||||
- FC_VESC broadcast rate (~10 Hz)
|
||||
- current_x10 scaling matches protocol spec
|
||||
|
||||
No ROS2 or real CAN hardware required.
|
||||
Run with: python -m pytest test/test_fc_vesc_broadcast.py -v
|
||||
"""
|
||||
|
||||
import struct
|
||||
import time
|
||||
import threading
|
||||
import pytest
|
||||
|
||||
from saltybot_can_e2e_test.can_mock import MockCANBus
|
||||
from saltybot_can_e2e_test.protocol_defs import (
|
||||
FC_VESC,
|
||||
VESC_CAN_ID_LEFT,
|
||||
VESC_CAN_ID_RIGHT,
|
||||
VESC_STATUS_ID,
|
||||
VESC_SET_RPM_ID,
|
||||
VESC_TELEM_STATE,
|
||||
build_vesc_status,
|
||||
build_fc_vesc,
|
||||
parse_fc_vesc,
|
||||
parse_vesc_status,
|
||||
)
|
||||
from saltybot_can_bridge.mamba_protocol import (
|
||||
VESC_TELEM_STATE as BRIDGE_VESC_TELEM_STATE,
|
||||
decode_vesc_state,
|
||||
)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Helpers
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
class VescStatusAggregator:
|
||||
"""
|
||||
Simulates the firmware logic that:
|
||||
1. Receives VESC STATUS extended frames from left/right VESCs
|
||||
2. Builds an FC_VESC broadcast payload
|
||||
3. Injects the FC_VESC frame onto the mock bus
|
||||
|
||||
This represents the Mamba → Orin telemetry path.
|
||||
"""
|
||||
|
||||
def __init__(self, bus: MockCANBus):
|
||||
self._bus = bus
|
||||
self._left_rpm_x10 = 0
|
||||
self._right_rpm_x10 = 0
|
||||
self._left_current_x10 = 0
|
||||
self._right_current_x10 = 0
|
||||
self._left_seen = False
|
||||
self._right_seen = False
|
||||
|
||||
def process_vesc_status(self, arb_id: int, data: bytes) -> None:
|
||||
"""
|
||||
Process an incoming VESC STATUS frame (extended 29-bit ID).
|
||||
Updates internal state; broadcasts FC_VESC when at least one side is known.
|
||||
"""
|
||||
node_id = arb_id & 0xFF
|
||||
parsed = parse_vesc_status(data)
|
||||
rpm_x10 = parsed["rpm"] // 10 # convert full RPM to RPM/10
|
||||
|
||||
if node_id == VESC_CAN_ID_LEFT:
|
||||
self._left_rpm_x10 = rpm_x10
|
||||
self._left_current_x10 = parsed["current_x10"]
|
||||
self._left_seen = True
|
||||
elif node_id == VESC_CAN_ID_RIGHT:
|
||||
self._right_rpm_x10 = rpm_x10
|
||||
self._right_current_x10 = parsed["current_x10"]
|
||||
self._right_seen = True
|
||||
|
||||
# Broadcast FC_VESC whenever we receive any update
|
||||
self._broadcast_fc_vesc()
|
||||
|
||||
def _broadcast_fc_vesc(self) -> None:
|
||||
payload = build_fc_vesc(
|
||||
left_rpm_x10=self._left_rpm_x10,
|
||||
right_rpm_x10=self._right_rpm_x10,
|
||||
left_current_x10=self._left_current_x10,
|
||||
right_current_x10=self._right_current_x10,
|
||||
)
|
||||
self._bus.inject(FC_VESC, payload)
|
||||
|
||||
|
||||
def _inject_vesc_status(bus: MockCANBus, vesc_id: int, rpm: int,
|
||||
current_x10: int = 50, duty_x1000: int = 250) -> None:
|
||||
"""Inject a VESC STATUS extended frame for the given node ID."""
|
||||
arb_id = VESC_STATUS_ID(vesc_id)
|
||||
payload = build_vesc_status(rpm=rpm, current_x10=current_x10, duty_x1000=duty_x1000)
|
||||
bus.inject(arb_id, payload, is_extended_id=True)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Tests
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
class TestVescStatusToFcVesc:
|
||||
def test_left_vesc_status_triggers_broadcast(self, mock_can_bus):
|
||||
"""
|
||||
Inject VESC STATUS for left VESC (ID 56) → verify FC_VESC contains
|
||||
the correct left RPM (rpm / 10).
|
||||
"""
|
||||
agg = VescStatusAggregator(mock_can_bus)
|
||||
|
||||
# Left VESC: 3000 RPM → rpm_x10 = 300
|
||||
arb_id = VESC_STATUS_ID(VESC_CAN_ID_LEFT)
|
||||
payload = build_vesc_status(rpm=3000, current_x10=55)
|
||||
agg.process_vesc_status(arb_id, payload)
|
||||
|
||||
frame = mock_can_bus.recv(timeout=0.1)
|
||||
assert frame is not None, "No FC_VESC broadcast after left VESC STATUS"
|
||||
parsed = parse_fc_vesc(bytes(frame.data))
|
||||
assert parsed["left_rpm_x10"] == 300, \
|
||||
f"left_rpm_x10 {parsed['left_rpm_x10']} != 300"
|
||||
assert abs(parsed["left_rpm"] - 3000.0) < 1.0
|
||||
|
||||
def test_right_vesc_status_triggers_broadcast(self, mock_can_bus):
|
||||
"""Inject VESC STATUS for right VESC (ID 68) → verify right RPM in FC_VESC."""
|
||||
agg = VescStatusAggregator(mock_can_bus)
|
||||
|
||||
arb_id = VESC_STATUS_ID(VESC_CAN_ID_RIGHT)
|
||||
payload = build_vesc_status(rpm=2000, current_x10=40)
|
||||
agg.process_vesc_status(arb_id, payload)
|
||||
|
||||
frame = mock_can_bus.recv(timeout=0.1)
|
||||
assert frame is not None
|
||||
parsed = parse_fc_vesc(bytes(frame.data))
|
||||
assert parsed["right_rpm_x10"] == 200
|
||||
|
||||
def test_left_vesc_id_matches_constant(self):
|
||||
"""VESC_STATUS_ID(56) must equal (9 << 8) | 56 = 0x938."""
|
||||
assert VESC_STATUS_ID(VESC_CAN_ID_LEFT) == (9 << 8) | 56
|
||||
assert VESC_STATUS_ID(VESC_CAN_ID_LEFT) == 0x938
|
||||
|
||||
def test_right_vesc_id_matches_constant(self):
|
||||
"""VESC_STATUS_ID(68) must equal (9 << 8) | 68 = 0x944."""
|
||||
assert VESC_STATUS_ID(VESC_CAN_ID_RIGHT) == (9 << 8) | 68
|
||||
assert VESC_STATUS_ID(VESC_CAN_ID_RIGHT) == 0x944
|
||||
|
||||
|
||||
class TestBothVescStatusCombined:
|
||||
def test_both_vesc_status_combined_in_fc_vesc(self, mock_can_bus):
|
||||
"""
|
||||
Inject both left (56) and right (68) VESC STATUS frames.
|
||||
Final FC_VESC must contain both RPMs.
|
||||
"""
|
||||
agg = VescStatusAggregator(mock_can_bus)
|
||||
|
||||
# Left: 3000 RPM
|
||||
agg.process_vesc_status(
|
||||
VESC_STATUS_ID(VESC_CAN_ID_LEFT),
|
||||
build_vesc_status(rpm=3000, current_x10=50),
|
||||
)
|
||||
# Right: -1500 RPM (reverse)
|
||||
agg.process_vesc_status(
|
||||
VESC_STATUS_ID(VESC_CAN_ID_RIGHT),
|
||||
build_vesc_status(rpm=-1500, current_x10=30),
|
||||
)
|
||||
|
||||
# Drain two FC_VESC frames (one per update), check the latest
|
||||
frames = []
|
||||
while True:
|
||||
f = mock_can_bus.recv(timeout=0.05)
|
||||
if f is None:
|
||||
break
|
||||
frames.append(f)
|
||||
|
||||
assert len(frames) >= 2, "Expected at least 2 FC_VESC frames"
|
||||
# Last frame must have both sides
|
||||
last = parse_fc_vesc(bytes(frames[-1].data))
|
||||
assert last["left_rpm_x10"] == 300, \
|
||||
f"left_rpm_x10 {last['left_rpm_x10']} != 300"
|
||||
assert last["right_rpm_x10"] == -150, \
|
||||
f"right_rpm_x10 {last['right_rpm_x10']} != -150"
|
||||
|
||||
def test_both_vesc_currents_combined(self, mock_can_bus):
|
||||
"""Both current values must appear in FC_VESC after two STATUS frames."""
|
||||
agg = VescStatusAggregator(mock_can_bus)
|
||||
agg.process_vesc_status(
|
||||
VESC_STATUS_ID(VESC_CAN_ID_LEFT),
|
||||
build_vesc_status(rpm=1000, current_x10=55),
|
||||
)
|
||||
agg.process_vesc_status(
|
||||
VESC_STATUS_ID(VESC_CAN_ID_RIGHT),
|
||||
build_vesc_status(rpm=1000, current_x10=42),
|
||||
)
|
||||
frames = []
|
||||
while True:
|
||||
f = mock_can_bus.recv(timeout=0.05)
|
||||
if f is None:
|
||||
break
|
||||
frames.append(f)
|
||||
last = parse_fc_vesc(bytes(frames[-1].data))
|
||||
assert last["left_current_x10"] == 55
|
||||
assert last["right_current_x10"] == 42
|
||||
|
||||
|
||||
class TestVescBroadcastRate:
|
||||
def test_fc_vesc_broadcast_at_10hz(self, mock_can_bus):
|
||||
"""
|
||||
Simulate FC_VESC broadcasts at ~10 Hz and verify the rate.
|
||||
We inject 12 frames over ~120 ms, then verify count and average interval.
|
||||
"""
|
||||
_FC_VESC_HZ = 10
|
||||
_interval = 1.0 / _FC_VESC_HZ
|
||||
|
||||
timestamps = []
|
||||
stop_event = threading.Event()
|
||||
|
||||
def broadcaster():
|
||||
while not stop_event.is_set():
|
||||
t = time.monotonic()
|
||||
mock_can_bus.inject(
|
||||
FC_VESC,
|
||||
build_fc_vesc(100, -100, 30, 30),
|
||||
timestamp=t,
|
||||
)
|
||||
timestamps.append(t)
|
||||
time.sleep(_interval)
|
||||
|
||||
t = threading.Thread(target=broadcaster, daemon=True)
|
||||
t.start()
|
||||
time.sleep(0.15) # collect ~1.5 broadcasts
|
||||
stop_event.set()
|
||||
t.join(timeout=0.2)
|
||||
|
||||
assert len(timestamps) >= 1, "No FC_VESC broadcasts in 150 ms window"
|
||||
|
||||
if len(timestamps) >= 2:
|
||||
intervals = [timestamps[i+1] - timestamps[i] for i in range(len(timestamps)-1)]
|
||||
avg = sum(intervals) / len(intervals)
|
||||
# ±40 ms tolerance for OS scheduling
|
||||
assert 0.06 <= avg <= 0.14, \
|
||||
f"FC_VESC broadcast interval {avg*1000:.1f} ms not ~100 ms"
|
||||
|
||||
def test_fc_vesc_frame_is_8_bytes(self):
|
||||
"""FC_VESC payload must always be exactly 8 bytes."""
|
||||
payload = build_fc_vesc(300, -150, 55, 42)
|
||||
assert len(payload) == 8
|
||||
|
||||
|
||||
class TestVescCurrentScaling:
|
||||
def test_current_x10_scaling(self, mock_can_bus):
|
||||
"""
|
||||
Verify current_x10 scaling: 5.5 A → current_x10=55.
|
||||
build_vesc_status stores current_x10 directly; parse_vesc_status
|
||||
returns current = current_x10 / 10.
|
||||
"""
|
||||
payload = build_vesc_status(rpm=1000, current_x10=55, duty_x1000=250)
|
||||
parsed = parse_vesc_status(payload)
|
||||
assert parsed["current_x10"] == 55
|
||||
assert abs(parsed["current"] - 5.5) < 0.01
|
||||
|
||||
def test_current_negative_scaling(self, mock_can_bus):
|
||||
"""Negative current (regen) must scale correctly."""
|
||||
payload = build_vesc_status(rpm=-500, current_x10=-30)
|
||||
parsed = parse_vesc_status(payload)
|
||||
assert parsed["current_x10"] == -30
|
||||
assert abs(parsed["current"] - (-3.0)) < 0.01
|
||||
|
||||
def test_fc_vesc_current_x10_roundtrip(self, mock_can_bus):
|
||||
"""build_fc_vesc → inject → recv → parse must preserve current_x10."""
|
||||
payload = build_fc_vesc(
|
||||
left_rpm_x10=200,
|
||||
right_rpm_x10=200,
|
||||
left_current_x10=55,
|
||||
right_current_x10=42,
|
||||
)
|
||||
mock_can_bus.inject(FC_VESC, payload)
|
||||
frame = mock_can_bus.recv(timeout=0.1)
|
||||
parsed = parse_fc_vesc(bytes(frame.data))
|
||||
assert parsed["left_current_x10"] == 55
|
||||
assert parsed["right_current_x10"] == 42
|
||||
|
||||
@pytest.mark.parametrize("vesc_id", [VESC_CAN_ID_LEFT, VESC_CAN_ID_RIGHT])
|
||||
def test_vesc_status_id_both_nodes(self, vesc_id, mock_can_bus):
|
||||
"""
|
||||
VESC_STATUS_ID(vesc_id) must produce the correct 29-bit extended arb_id
|
||||
for both the left (56) and right (68) node IDs.
|
||||
"""
|
||||
expected = (9 << 8) | vesc_id
|
||||
assert VESC_STATUS_ID(vesc_id) == expected
|
||||
|
||||
@pytest.mark.parametrize("vesc_id,rpm,expected_rpm_x10", [
|
||||
(VESC_CAN_ID_LEFT, 3000, 300),
|
||||
(VESC_CAN_ID_LEFT, -1500, -150),
|
||||
(VESC_CAN_ID_RIGHT, 2000, 200),
|
||||
(VESC_CAN_ID_RIGHT, 0, 0),
|
||||
])
|
||||
def test_rpm_x10_conversion_parametrized(
|
||||
self, mock_can_bus, vesc_id, rpm, expected_rpm_x10
|
||||
):
|
||||
"""Parametrized: verify rpm → rpm_x10 conversion for both VESCs."""
|
||||
agg = VescStatusAggregator(mock_can_bus)
|
||||
agg.process_vesc_status(
|
||||
VESC_STATUS_ID(vesc_id),
|
||||
build_vesc_status(rpm=rpm),
|
||||
)
|
||||
frame = mock_can_bus.recv(timeout=0.05)
|
||||
assert frame is not None
|
||||
parsed = parse_fc_vesc(bytes(frame.data))
|
||||
if vesc_id == VESC_CAN_ID_LEFT:
|
||||
assert parsed["left_rpm_x10"] == expected_rpm_x10, \
|
||||
f"left_rpm_x10={parsed['left_rpm_x10']} expected {expected_rpm_x10}"
|
||||
else:
|
||||
assert parsed["right_rpm_x10"] == expected_rpm_x10, \
|
||||
f"right_rpm_x10={parsed['right_rpm_x10']} expected {expected_rpm_x10}"
|
||||
@ -0,0 +1,238 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
test_heartbeat_timeout.py — Tests for heartbeat loss and recovery.
|
||||
|
||||
Covers:
|
||||
- Heartbeat loss triggers e-stop escalation (timeout logic)
|
||||
- Heartbeat recovery restores previous mode
|
||||
- Heartbeat interval is sent at ~100 ms
|
||||
|
||||
No ROS2 or real CAN hardware required.
|
||||
Run with: python -m pytest test/test_heartbeat_timeout.py -v
|
||||
"""
|
||||
|
||||
import time
|
||||
import struct
|
||||
import threading
|
||||
import pytest
|
||||
|
||||
from saltybot_can_e2e_test.can_mock import MockCANBus
|
||||
from saltybot_can_e2e_test.protocol_defs import (
|
||||
ORIN_CMD_HEARTBEAT,
|
||||
ORIN_CMD_ESTOP,
|
||||
ORIN_CMD_MODE,
|
||||
MAMBA_CMD_VELOCITY,
|
||||
MAMBA_CMD_MODE,
|
||||
MAMBA_CMD_ESTOP,
|
||||
MODE_IDLE,
|
||||
MODE_DRIVE,
|
||||
MODE_ESTOP,
|
||||
build_heartbeat,
|
||||
build_estop_cmd,
|
||||
build_mode_cmd,
|
||||
build_velocity_cmd,
|
||||
parse_velocity_cmd,
|
||||
)
|
||||
from saltybot_can_bridge.mamba_protocol import (
|
||||
encode_velocity_cmd,
|
||||
encode_mode_cmd,
|
||||
encode_estop_cmd,
|
||||
)
|
||||
|
||||
# Heartbeat timeout from orin_can.h: 500 ms
|
||||
ORIN_HB_TIMEOUT_MS = 500
|
||||
ORIN_HB_TIMEOUT_S = ORIN_HB_TIMEOUT_MS / 1000.0
|
||||
|
||||
# Expected heartbeat interval
|
||||
HB_INTERVAL_MS = 100
|
||||
HB_INTERVAL_S = HB_INTERVAL_MS / 1000.0
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Helpers
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
class HeartbeatSimulator:
|
||||
"""
|
||||
Simulate periodic heartbeat injection into a MockCANBus.
|
||||
|
||||
Call start() to begin sending heartbeats every interval_s.
|
||||
Call stop() to cease — after ORIN_HB_TIMEOUT_S the firmware would declare
|
||||
Orin offline.
|
||||
"""
|
||||
|
||||
def __init__(self, bus: MockCANBus, interval_s: float = HB_INTERVAL_S):
|
||||
self._bus = bus
|
||||
self._interval_s = interval_s
|
||||
self._seq = 0
|
||||
self._running = False
|
||||
self._thread: threading.Thread | None = None
|
||||
|
||||
def start(self):
|
||||
self._running = True
|
||||
self._thread = threading.Thread(target=self._run, daemon=True)
|
||||
self._thread.start()
|
||||
|
||||
def stop(self):
|
||||
self._running = False
|
||||
|
||||
def _run(self):
|
||||
while self._running:
|
||||
self._bus.inject(
|
||||
ORIN_CMD_HEARTBEAT,
|
||||
build_heartbeat(self._seq),
|
||||
is_extended_id=False,
|
||||
)
|
||||
self._seq += 1
|
||||
time.sleep(self._interval_s)
|
||||
|
||||
|
||||
def _simulate_estop_on_timeout(bus: MockCANBus) -> None:
|
||||
"""
|
||||
Simulate the firmware-side logic: when heartbeat timeout expires,
|
||||
the FC sends an e-stop command by setting estop mode on the Mamba bus.
|
||||
We model this as the bridge sending zero velocity + ESTOP mode.
|
||||
"""
|
||||
|
||||
class _Msg:
|
||||
def __init__(self, arb_id, data):
|
||||
self.arbitration_id = arb_id
|
||||
self.data = bytearray(data)
|
||||
self.is_extended_id = False
|
||||
|
||||
bus.send(_Msg(MAMBA_CMD_VELOCITY, encode_velocity_cmd(0.0, 0.0)))
|
||||
bus.send(_Msg(MAMBA_CMD_MODE, encode_mode_cmd(MODE_ESTOP)))
|
||||
bus.send(_Msg(MAMBA_CMD_ESTOP, encode_estop_cmd(True)))
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Tests
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
class TestHeartbeatLoss:
|
||||
def test_heartbeat_loss_triggers_estop(self, mock_can_bus):
|
||||
"""
|
||||
After heartbeat ceases, the bridge must command zero velocity and
|
||||
set ESTOP mode. We simulate this directly using _simulate_estop_on_timeout.
|
||||
"""
|
||||
# First confirm the bus is clean
|
||||
assert len(mock_can_bus.get_sent_frames()) == 0
|
||||
|
||||
# Simulate bridge detecting timeout and escalating
|
||||
_simulate_estop_on_timeout(mock_can_bus)
|
||||
|
||||
vel_frames = mock_can_bus.get_sent_frames_by_id(MAMBA_CMD_VELOCITY)
|
||||
assert len(vel_frames) >= 1, "Zero velocity not sent after timeout"
|
||||
l, r = parse_velocity_cmd(bytes(vel_frames[-1].data))
|
||||
assert abs(l) < 1e-5, "Left not zero on timeout"
|
||||
assert abs(r) < 1e-5, "Right not zero on timeout"
|
||||
|
||||
mode_frames = mock_can_bus.get_sent_frames_by_id(MAMBA_CMD_MODE)
|
||||
assert any(
|
||||
bytes(f.data) == bytes([MODE_ESTOP]) for f in mode_frames
|
||||
), "ESTOP mode not asserted on heartbeat timeout"
|
||||
|
||||
estop_frames = mock_can_bus.get_sent_frames_by_id(MAMBA_CMD_ESTOP)
|
||||
assert len(estop_frames) >= 1, "ESTOP command not sent"
|
||||
assert bytes(estop_frames[0].data) == b"\x01"
|
||||
|
||||
def test_heartbeat_loss_zero_velocity(self, mock_can_bus):
|
||||
"""Zero velocity frame must appear among sent frames after timeout."""
|
||||
_simulate_estop_on_timeout(mock_can_bus)
|
||||
vel_frames = mock_can_bus.get_sent_frames_by_id(MAMBA_CMD_VELOCITY)
|
||||
assert len(vel_frames) >= 1
|
||||
for f in vel_frames:
|
||||
l, r = parse_velocity_cmd(bytes(f.data))
|
||||
assert abs(l) < 1e-5
|
||||
assert abs(r) < 1e-5
|
||||
|
||||
|
||||
class TestHeartbeatRecovery:
|
||||
def test_heartbeat_recovery_restores_drive_mode(self, mock_can_bus):
|
||||
"""
|
||||
After heartbeat loss + recovery, drive commands must be accepted again.
|
||||
We simulate: ESTOP → clear estop → send drive → verify velocity frame.
|
||||
"""
|
||||
|
||||
class _Msg:
|
||||
def __init__(self, arb_id, data):
|
||||
self.arbitration_id = arb_id
|
||||
self.data = bytearray(data)
|
||||
self.is_extended_id = False
|
||||
|
||||
# Phase 1: timeout → estop
|
||||
_simulate_estop_on_timeout(mock_can_bus)
|
||||
mock_can_bus.reset()
|
||||
|
||||
# Phase 2: recovery — clear estop, restore drive mode
|
||||
mock_can_bus.send(_Msg(MAMBA_CMD_ESTOP, encode_estop_cmd(False)))
|
||||
mock_can_bus.send(_Msg(MAMBA_CMD_MODE, encode_mode_cmd(MODE_DRIVE)))
|
||||
mock_can_bus.send(_Msg(MAMBA_CMD_VELOCITY, encode_velocity_cmd(0.5, 0.5)))
|
||||
|
||||
estop_frames = mock_can_bus.get_sent_frames_by_id(MAMBA_CMD_ESTOP)
|
||||
assert any(bytes(f.data) == b"\x00" for f in estop_frames), \
|
||||
"ESTOP clear not sent on recovery"
|
||||
|
||||
mode_frames = mock_can_bus.get_sent_frames_by_id(MAMBA_CMD_MODE)
|
||||
assert any(
|
||||
bytes(f.data) == bytes([MODE_DRIVE]) for f in mode_frames
|
||||
), "DRIVE mode not restored after recovery"
|
||||
|
||||
vel_frames = mock_can_bus.get_sent_frames_by_id(MAMBA_CMD_VELOCITY)
|
||||
assert len(vel_frames) >= 1
|
||||
l, r = parse_velocity_cmd(bytes(vel_frames[-1].data))
|
||||
assert abs(l - 0.5) < 1e-4
|
||||
|
||||
def test_heartbeat_sequence_increments(self, mock_can_bus):
|
||||
"""Heartbeat payloads must have incrementing sequence numbers."""
|
||||
payloads = []
|
||||
for seq in range(5):
|
||||
mock_can_bus.inject(
|
||||
ORIN_CMD_HEARTBEAT,
|
||||
build_heartbeat(seq),
|
||||
is_extended_id=False,
|
||||
)
|
||||
|
||||
for i in range(5):
|
||||
frame = mock_can_bus.recv(timeout=0.05)
|
||||
assert frame is not None
|
||||
(seq_val,) = struct.unpack(">I", bytes(frame.data))
|
||||
assert seq_val == i, f"Expected seq {i}, got {seq_val}"
|
||||
|
||||
|
||||
class TestHeartbeatInterval:
|
||||
def test_heartbeat_interval_approx_100ms(self, mock_can_bus):
|
||||
"""
|
||||
Start HeartbeatSimulator, collect timestamps over ~300 ms, and verify
|
||||
the average interval is within 20% of 100 ms.
|
||||
"""
|
||||
sim = HeartbeatSimulator(mock_can_bus, interval_s=0.1)
|
||||
sim.start()
|
||||
time.sleep(0.35)
|
||||
sim.stop()
|
||||
|
||||
timestamps = []
|
||||
while True:
|
||||
frame = mock_can_bus.recv(timeout=0.01)
|
||||
if frame is None:
|
||||
break
|
||||
if frame.arbitration_id == ORIN_CMD_HEARTBEAT:
|
||||
timestamps.append(frame.timestamp)
|
||||
|
||||
assert len(timestamps) >= 2, "Not enough heartbeat frames captured"
|
||||
|
||||
intervals = [
|
||||
timestamps[i + 1] - timestamps[i]
|
||||
for i in range(len(timestamps) - 1)
|
||||
]
|
||||
avg_interval = sum(intervals) / len(intervals)
|
||||
# Allow ±30 ms tolerance (OS scheduling jitter in CI)
|
||||
assert 0.07 <= avg_interval <= 0.13, \
|
||||
f"Average heartbeat interval {avg_interval*1000:.1f} ms not ~100 ms"
|
||||
|
||||
def test_heartbeat_payload_is_4_bytes(self, mock_can_bus):
|
||||
"""Heartbeat payload must be exactly 4 bytes (uint32 sequence)."""
|
||||
for seq in (0, 1, 0xFFFFFFFF):
|
||||
payload = build_heartbeat(seq)
|
||||
assert len(payload) == 4, \
|
||||
f"Heartbeat payload length {len(payload)} != 4"
|
||||
@ -0,0 +1,236 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
test_mode_switching.py — Mode transition integration tests.
|
||||
|
||||
Covers:
|
||||
- idle → drive: drive commands become accepted
|
||||
- drive → estop: immediate motor stop
|
||||
- MODE frame byte values match protocol constants
|
||||
- Unknown mode byte is ignored (no state change)
|
||||
|
||||
No ROS2 or real CAN hardware required.
|
||||
Run with: python -m pytest test/test_mode_switching.py -v
|
||||
"""
|
||||
|
||||
import struct
|
||||
import pytest
|
||||
|
||||
from saltybot_can_e2e_test.can_mock import MockCANBus
|
||||
from saltybot_can_e2e_test.protocol_defs import (
|
||||
MAMBA_CMD_VELOCITY,
|
||||
MAMBA_CMD_MODE,
|
||||
MAMBA_CMD_ESTOP,
|
||||
MODE_IDLE,
|
||||
MODE_DRIVE,
|
||||
MODE_ESTOP,
|
||||
build_mode_cmd,
|
||||
build_velocity_cmd,
|
||||
parse_velocity_cmd,
|
||||
)
|
||||
from saltybot_can_bridge.mamba_protocol import (
|
||||
encode_velocity_cmd,
|
||||
encode_mode_cmd,
|
||||
encode_estop_cmd,
|
||||
)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Helpers
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
class _Msg:
|
||||
def __init__(self, arb_id: int, data: bytes, is_extended_id: bool = False):
|
||||
self.arbitration_id = arb_id
|
||||
self.data = bytearray(data)
|
||||
self.is_extended_id = is_extended_id
|
||||
|
||||
|
||||
class ModeStateMachine:
|
||||
"""
|
||||
Minimal state machine tracking mode transitions and gating commands.
|
||||
"""
|
||||
|
||||
def __init__(self, bus: MockCANBus):
|
||||
self._bus = bus
|
||||
self._mode = MODE_IDLE
|
||||
|
||||
def set_mode(self, mode: int) -> bool:
|
||||
"""
|
||||
Transition to mode. Returns True if accepted, False if invalid.
|
||||
Invalid mode values (not 0, 1, 2) are ignored.
|
||||
"""
|
||||
if mode not in (MODE_IDLE, MODE_DRIVE, MODE_ESTOP):
|
||||
return False # silently ignore
|
||||
|
||||
prev_mode = self._mode
|
||||
self._mode = mode
|
||||
self._bus.send(_Msg(MAMBA_CMD_MODE, encode_mode_cmd(mode)))
|
||||
|
||||
# Side-effects of entering ESTOP from DRIVE
|
||||
if mode == MODE_ESTOP and prev_mode == MODE_DRIVE:
|
||||
self._bus.send(_Msg(MAMBA_CMD_VELOCITY, encode_velocity_cmd(0.0, 0.0)))
|
||||
self._bus.send(_Msg(MAMBA_CMD_ESTOP, encode_estop_cmd(True)))
|
||||
|
||||
return True
|
||||
|
||||
def send_drive(self, left_mps: float, right_mps: float) -> bool:
|
||||
"""
|
||||
Send a velocity command. Returns True if forwarded, False if blocked.
|
||||
"""
|
||||
if self._mode != MODE_DRIVE:
|
||||
return False
|
||||
self._bus.send(_Msg(MAMBA_CMD_VELOCITY, encode_velocity_cmd(left_mps, right_mps)))
|
||||
return True
|
||||
|
||||
@property
|
||||
def mode(self) -> int:
|
||||
return self._mode
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Tests
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
class TestIdleToDrive:
|
||||
def test_idle_to_drive_mode_frame(self, mock_can_bus):
|
||||
"""Transitioning to DRIVE must emit a MODE=drive frame."""
|
||||
sm = ModeStateMachine(mock_can_bus)
|
||||
sm.set_mode(MODE_DRIVE)
|
||||
|
||||
mode_frames = mock_can_bus.get_sent_frames_by_id(MAMBA_CMD_MODE)
|
||||
assert len(mode_frames) == 1
|
||||
assert bytes(mode_frames[0].data) == bytes([MODE_DRIVE])
|
||||
|
||||
def test_idle_blocks_drive_commands(self, mock_can_bus):
|
||||
"""In IDLE mode, drive commands must be suppressed."""
|
||||
sm = ModeStateMachine(mock_can_bus)
|
||||
# Attempt drive without entering DRIVE mode
|
||||
forwarded = sm.send_drive(1.0, 1.0)
|
||||
assert forwarded is False, "Drive cmd should be blocked in IDLE mode"
|
||||
|
||||
vel_frames = mock_can_bus.get_sent_frames_by_id(MAMBA_CMD_VELOCITY)
|
||||
assert len(vel_frames) == 0
|
||||
|
||||
def test_drive_mode_allows_commands(self, mock_can_bus):
|
||||
"""After entering DRIVE mode, velocity commands must be forwarded."""
|
||||
sm = ModeStateMachine(mock_can_bus)
|
||||
sm.set_mode(MODE_DRIVE)
|
||||
mock_can_bus.reset()
|
||||
|
||||
forwarded = sm.send_drive(0.5, 0.5)
|
||||
assert forwarded is True
|
||||
|
||||
vel_frames = mock_can_bus.get_sent_frames_by_id(MAMBA_CMD_VELOCITY)
|
||||
assert len(vel_frames) == 1
|
||||
l, r = parse_velocity_cmd(bytes(vel_frames[0].data))
|
||||
assert abs(l - 0.5) < 1e-4
|
||||
assert abs(r - 0.5) < 1e-4
|
||||
|
||||
|
||||
class TestDriveToEstop:
|
||||
def test_drive_to_estop_stops_motors(self, mock_can_bus):
|
||||
"""Transitioning DRIVE → ESTOP must immediately send zero velocity."""
|
||||
sm = ModeStateMachine(mock_can_bus)
|
||||
sm.set_mode(MODE_DRIVE)
|
||||
sm.send_drive(1.0, 1.0)
|
||||
mock_can_bus.reset()
|
||||
|
||||
sm.set_mode(MODE_ESTOP)
|
||||
|
||||
vel_frames = mock_can_bus.get_sent_frames_by_id(MAMBA_CMD_VELOCITY)
|
||||
assert len(vel_frames) >= 1, "No velocity frame on DRIVE→ESTOP transition"
|
||||
l, r = parse_velocity_cmd(bytes(vel_frames[-1].data))
|
||||
assert abs(l) < 1e-5, f"Left motor {l} not zero after ESTOP"
|
||||
assert abs(r) < 1e-5, f"Right motor {r} not zero after ESTOP"
|
||||
|
||||
def test_drive_to_estop_mode_frame(self, mock_can_bus):
|
||||
"""DRIVE → ESTOP must broadcast MODE=estop."""
|
||||
sm = ModeStateMachine(mock_can_bus)
|
||||
sm.set_mode(MODE_DRIVE)
|
||||
sm.set_mode(MODE_ESTOP)
|
||||
|
||||
mode_frames = mock_can_bus.get_sent_frames_by_id(MAMBA_CMD_MODE)
|
||||
assert any(bytes(f.data) == bytes([MODE_ESTOP]) for f in mode_frames)
|
||||
|
||||
def test_estop_blocks_subsequent_drive(self, mock_can_bus):
|
||||
"""After DRIVE → ESTOP, drive commands must be blocked."""
|
||||
sm = ModeStateMachine(mock_can_bus)
|
||||
sm.set_mode(MODE_DRIVE)
|
||||
sm.set_mode(MODE_ESTOP)
|
||||
mock_can_bus.reset()
|
||||
|
||||
forwarded = sm.send_drive(1.0, 1.0)
|
||||
assert forwarded is False
|
||||
|
||||
vel_frames = mock_can_bus.get_sent_frames_by_id(MAMBA_CMD_VELOCITY)
|
||||
assert len(vel_frames) == 0
|
||||
|
||||
|
||||
class TestModeCommandEncoding:
|
||||
def test_mode_idle_byte(self, mock_can_bus):
|
||||
"""MODE_IDLE must encode as 0x00."""
|
||||
assert encode_mode_cmd(MODE_IDLE) == b"\x00"
|
||||
|
||||
def test_mode_drive_byte(self, mock_can_bus):
|
||||
"""MODE_DRIVE must encode as 0x01."""
|
||||
assert encode_mode_cmd(MODE_DRIVE) == b"\x01"
|
||||
|
||||
def test_mode_estop_byte(self, mock_can_bus):
|
||||
"""MODE_ESTOP must encode as 0x02."""
|
||||
assert encode_mode_cmd(MODE_ESTOP) == b"\x02"
|
||||
|
||||
def test_mode_frame_length(self, mock_can_bus):
|
||||
"""Mode command payload must be exactly 1 byte."""
|
||||
for mode in (MODE_IDLE, MODE_DRIVE, MODE_ESTOP):
|
||||
payload = encode_mode_cmd(mode)
|
||||
assert len(payload) == 1, f"Mode {mode} payload length {len(payload)} != 1"
|
||||
|
||||
def test_protocol_defs_build_mode_cmd_matches(self):
|
||||
"""build_mode_cmd in protocol_defs must produce identical bytes."""
|
||||
for mode in (MODE_IDLE, MODE_DRIVE, MODE_ESTOP):
|
||||
assert build_mode_cmd(mode) == encode_mode_cmd(mode), \
|
||||
f"protocol_defs.build_mode_cmd({mode}) != mamba_protocol.encode_mode_cmd({mode})"
|
||||
|
||||
|
||||
class TestInvalidMode:
|
||||
def test_invalid_mode_byte_ignored(self, mock_can_bus):
|
||||
"""Unknown mode byte (e.g. 0xFF) must be rejected — no state change."""
|
||||
sm = ModeStateMachine(mock_can_bus)
|
||||
sm.set_mode(MODE_DRIVE)
|
||||
initial_mode = sm.mode
|
||||
mock_can_bus.reset()
|
||||
|
||||
accepted = sm.set_mode(0xFF)
|
||||
assert accepted is False, "Invalid mode 0xFF should be rejected"
|
||||
assert sm.mode == initial_mode, "Mode changed despite invalid value"
|
||||
assert len(mock_can_bus.get_sent_frames()) == 0, \
|
||||
"Frames sent for invalid mode command"
|
||||
|
||||
def test_invalid_mode_99_ignored(self, mock_can_bus):
|
||||
"""Mode 99 must be rejected."""
|
||||
sm = ModeStateMachine(mock_can_bus)
|
||||
accepted = sm.set_mode(99)
|
||||
assert accepted is False
|
||||
|
||||
def test_invalid_mode_negative_ignored(self, mock_can_bus):
|
||||
"""Negative mode values must be rejected."""
|
||||
sm = ModeStateMachine(mock_can_bus)
|
||||
accepted = sm.set_mode(-1)
|
||||
assert accepted is False
|
||||
|
||||
def test_mamba_protocol_invalid_mode_raises(self):
|
||||
"""mamba_protocol.encode_mode_cmd must raise on invalid mode."""
|
||||
with pytest.raises(ValueError):
|
||||
encode_mode_cmd(99)
|
||||
with pytest.raises(ValueError):
|
||||
encode_mode_cmd(-1)
|
||||
|
||||
|
||||
@pytest.mark.parametrize("mode,expected_byte", [
|
||||
(MODE_IDLE, b"\x00"),
|
||||
(MODE_DRIVE, b"\x01"),
|
||||
(MODE_ESTOP, b"\x02"),
|
||||
])
|
||||
def test_mode_encoding_parametrized(mode, expected_byte):
|
||||
"""Parametrized check that all mode constants encode to the right byte."""
|
||||
assert encode_mode_cmd(mode) == expected_byte
|
||||
@ -0,0 +1,22 @@
|
||||
# map_saver_params.yaml — nav2_map_server map_saver_server config (Issue #696)
|
||||
#
|
||||
# map_saver_server is a lifecycle node from nav2_map_server that exposes the
|
||||
# /map_saver/save_map action (nav2_msgs/action/SaveMap). It is included in
|
||||
# the SLAM bringup so operators can trigger a map save without restarting.
|
||||
#
|
||||
# Save a map (while SLAM is running):
|
||||
# ros2 run nav2_map_server map_saver_cli \
|
||||
# -f /mnt/nvme/saltybot/maps/saltybot_map --map_subscribe_transient_local
|
||||
#
|
||||
# Or via action:
|
||||
# ros2 action send_goal /map_saver/save_map nav2_msgs/action/SaveMap \
|
||||
# '{map_topic: "map", map_url: "/mnt/nvme/saltybot/maps/saltybot_map",
|
||||
# image_format: "pgm", map_mode: "trinary",
|
||||
# free_thresh: 0.25, occupied_thresh: 0.65}'
|
||||
|
||||
map_saver:
|
||||
ros__parameters:
|
||||
save_map_timeout: 5.0 # s — time to wait for /map topic on save
|
||||
free_thresh_default: 0.25 # p ≤ 0.25 → free cell
|
||||
occupied_thresh_default: 0.65 # p ≥ 0.65 → occupied cell
|
||||
map_subscribe_transient_local: true # use transient-local QoS (required for /map)
|
||||
@ -0,0 +1,143 @@
|
||||
"""
|
||||
map_persistence.launch.py — Map save/load lifecycle nodes (Issue #696).
|
||||
|
||||
Launches:
|
||||
1. map_saver_server — nav2_map_server lifecycle node; exposes
|
||||
/map_saver/save_map action (nav2_msgs/action/SaveMap)
|
||||
2. saltybot_map_saver — helper node: /saltybot/save_map Trigger service,
|
||||
startup check, optional auto-save on shutdown
|
||||
3. lifecycle_manager_map_saver — manages map_saver_server transitions
|
||||
|
||||
Arguments
|
||||
─────────
|
||||
map_dir path to map storage directory
|
||||
(default: /mnt/nvme/saltybot/maps)
|
||||
map_name base filename for saved map, no extension
|
||||
(default: saltybot_map)
|
||||
use_sim_time (default: false)
|
||||
autostart lifecycle manager autostart (default: true)
|
||||
|
||||
Save a map (CLI shortcut while SLAM is running):
|
||||
ros2 service call /saltybot/save_map std_srvs/srv/Trigger {}
|
||||
|
||||
Or directly via map_saver_cli:
|
||||
ros2 run nav2_map_server map_saver_cli \\
|
||||
-f /mnt/nvme/saltybot/maps/saltybot_map --map_subscribe_transient_local
|
||||
|
||||
Load on next startup:
|
||||
ros2 launch saltybot_nav2_slam nav2_amcl_bringup.launch.py
|
||||
# auto-detects /mnt/nvme/saltybot/maps/saltybot_map.yaml if present
|
||||
"""
|
||||
|
||||
import os
|
||||
|
||||
from ament_index_python.packages import get_package_share_directory
|
||||
|
||||
from launch import LaunchDescription
|
||||
from launch.actions import DeclareLaunchArgument, LogInfo
|
||||
from launch.substitutions import LaunchConfiguration
|
||||
from launch_ros.actions import Node
|
||||
|
||||
|
||||
def generate_launch_description() -> LaunchDescription:
|
||||
nav2_slam_dir = get_package_share_directory("saltybot_nav2_slam")
|
||||
map_saver_params = os.path.join(nav2_slam_dir, "config", "map_saver_params.yaml")
|
||||
|
||||
# ── Arguments ─────────────────────────────────────────────────────────────
|
||||
|
||||
map_dir_arg = DeclareLaunchArgument(
|
||||
"map_dir",
|
||||
default_value="/mnt/nvme/saltybot/maps",
|
||||
description="Directory for saving/loading map files (.yaml + .pgm)",
|
||||
)
|
||||
|
||||
map_name_arg = DeclareLaunchArgument(
|
||||
"map_name",
|
||||
default_value="saltybot_map",
|
||||
description="Base filename for saved map (no extension)",
|
||||
)
|
||||
|
||||
use_sim_time_arg = DeclareLaunchArgument(
|
||||
"use_sim_time",
|
||||
default_value="false",
|
||||
description="Use simulated clock",
|
||||
)
|
||||
|
||||
autostart_arg = DeclareLaunchArgument(
|
||||
"autostart",
|
||||
default_value="true",
|
||||
description="Automatically configure/activate lifecycle nodes",
|
||||
)
|
||||
|
||||
# ── Substitutions ─────────────────────────────────────────────────────────
|
||||
|
||||
map_dir = LaunchConfiguration("map_dir")
|
||||
map_name = LaunchConfiguration("map_name")
|
||||
use_sim_time = LaunchConfiguration("use_sim_time")
|
||||
autostart = LaunchConfiguration("autostart")
|
||||
|
||||
# ── map_saver_server (nav2_map_server lifecycle node) ─────────────────────
|
||||
# Exposes /map_saver/save_map action server when active.
|
||||
|
||||
map_saver_server = Node(
|
||||
package="nav2_map_server",
|
||||
executable="map_saver_server",
|
||||
name="map_saver",
|
||||
output="screen",
|
||||
respawn=True,
|
||||
respawn_delay=2.0,
|
||||
parameters=[
|
||||
map_saver_params,
|
||||
{"use_sim_time": use_sim_time},
|
||||
],
|
||||
)
|
||||
|
||||
# ── saltybot_map_saver helper node ────────────────────────────────────────
|
||||
# /saltybot/save_map Trigger service + startup reporting + auto-save.
|
||||
|
||||
map_saver_helper = Node(
|
||||
package="saltybot_nav2_slam",
|
||||
executable="map_saver_node",
|
||||
name="saltybot_map_saver",
|
||||
output="screen",
|
||||
parameters=[
|
||||
{
|
||||
"map_dir": map_dir,
|
||||
"map_name": map_name,
|
||||
"auto_save_on_shutdown": True,
|
||||
"use_sim_time": use_sim_time,
|
||||
}
|
||||
],
|
||||
)
|
||||
|
||||
# ── Lifecycle manager for map_saver_server ────────────────────────────────
|
||||
|
||||
lifecycle_manager = Node(
|
||||
package="nav2_lifecycle_manager",
|
||||
executable="lifecycle_manager",
|
||||
name="lifecycle_manager_map_saver",
|
||||
output="screen",
|
||||
parameters=[
|
||||
{
|
||||
"use_sim_time": use_sim_time,
|
||||
"autostart": autostart,
|
||||
"node_names": ["map_saver"],
|
||||
}
|
||||
],
|
||||
)
|
||||
|
||||
return LaunchDescription([
|
||||
# Arguments
|
||||
map_dir_arg,
|
||||
map_name_arg,
|
||||
use_sim_time_arg,
|
||||
autostart_arg,
|
||||
|
||||
# Banner
|
||||
LogInfo(msg="[map_persistence] Starting map_saver_server + helper (Issue #696)"),
|
||||
|
||||
# Nodes
|
||||
map_saver_server,
|
||||
map_saver_helper,
|
||||
lifecycle_manager,
|
||||
])
|
||||
@ -1,188 +1,96 @@
|
||||
"""
|
||||
nav2_amcl_bringup.launch.py — Nav2 with AMCL localization (Issue #655).
|
||||
"""nav2_amcl_bringup.launch.py (Issue #655, #696) — AMCL + auto map detection.
|
||||
|
||||
Full autonomous navigation stack for SaltyBot using a pre-built static map
|
||||
and AMCL particle-filter localization.
|
||||
Map selection (Issue #696): if /mnt/nvme/saltybot/maps/saltybot_map.yaml exists
|
||||
at launch time, it is used automatically. Otherwise falls back to placeholder.
|
||||
|
||||
Odometry: /odom from vesc_can_odometry (VESC CAN IDs 61/79, Issue #646)
|
||||
LiDAR: /scan from RPLIDAR A1M8 (via saltybot_bringup sensors.launch.py)
|
||||
Map: static OccupancyGrid loaded by map_server (defaults to placeholder)
|
||||
|
||||
Startup sequence
|
||||
────────────────
|
||||
1. Sensors — RealSense D435i + RPLIDAR A1M8 drivers + static TF
|
||||
2. VESC odometry — /odom (differential drive from dual CAN motors)
|
||||
3. Localization — map_server + AMCL (nav2_bringup localization_launch.py)
|
||||
4. Navigation — controller + planner + behaviors + BT navigator
|
||||
(nav2_bringup navigation_launch.py)
|
||||
|
||||
Arguments
|
||||
─────────
|
||||
map path to map YAML (default: maps/saltybot_map.yaml placeholder)
|
||||
use_sim_time (default: false)
|
||||
autostart lifecycle manager autostart (default: true)
|
||||
params_file Nav2 params override (default: config/amcl_nav2_params.yaml)
|
||||
include_sensors launch sensors.launch.py (default: true — set false if
|
||||
sensors are already running)
|
||||
|
||||
Usage
|
||||
─────
|
||||
# Minimal — sensors included, placeholder map:
|
||||
Usage:
|
||||
ros2 launch saltybot_nav2_slam nav2_amcl_bringup.launch.py
|
||||
|
||||
# With a real saved map:
|
||||
ros2 launch saltybot_nav2_slam nav2_amcl_bringup.launch.py \
|
||||
map:=/mnt/nvme/saltybot/maps/my_map.yaml
|
||||
|
||||
# Without sensor bringup (sensors already running):
|
||||
ros2 launch saltybot_nav2_slam nav2_amcl_bringup.launch.py \
|
||||
include_sensors:=false
|
||||
|
||||
Integration with saltybot_bringup
|
||||
──────────────────────────────────
|
||||
The saltybot_bringup orchestrator (saltybot_bringup.launch.py) calls
|
||||
nav2.launch.py at t=22 s in GROUP C. To use AMCL instead of RTAB-Map:
|
||||
ros2 launch saltybot_bringup nav2.launch.py nav_mode:=amcl
|
||||
ros2 launch saltybot_nav2_slam nav2_amcl_bringup.launch.py map_dir:=/mnt/nvme/saltybot/maps
|
||||
ros2 launch saltybot_nav2_slam nav2_amcl_bringup.launch.py map:=/path/to/room.yaml
|
||||
ros2 launch saltybot_nav2_slam nav2_amcl_bringup.launch.py include_sensors:=false
|
||||
"""
|
||||
|
||||
import os
|
||||
|
||||
from ament_index_python.packages import get_package_share_directory
|
||||
|
||||
from launch import LaunchDescription
|
||||
from launch.actions import (
|
||||
DeclareLaunchArgument,
|
||||
GroupAction,
|
||||
IncludeLaunchDescription,
|
||||
LogInfo,
|
||||
)
|
||||
from launch.actions import DeclareLaunchArgument, GroupAction, IncludeLaunchDescription, LogInfo
|
||||
from launch.conditions import IfCondition
|
||||
from launch.launch_description_sources import PythonLaunchDescriptionSource
|
||||
from launch.substitutions import LaunchConfiguration
|
||||
|
||||
# Map auto-detection (Issue #696): evaluated at ros2 launch time on the Jetson.
|
||||
_NVME_MAP_DIR = "/mnt/nvme/saltybot/maps"
|
||||
_NVME_MAP_YAML = os.path.join(_NVME_MAP_DIR, "saltybot_map.yaml")
|
||||
|
||||
|
||||
def _default_map() -> str:
|
||||
if os.path.isfile(_NVME_MAP_YAML):
|
||||
return _NVME_MAP_YAML
|
||||
nav2_slam_dir = get_package_share_directory("saltybot_nav2_slam")
|
||||
return os.path.join(nav2_slam_dir, "maps", "saltybot_map.yaml")
|
||||
|
||||
|
||||
def generate_launch_description() -> LaunchDescription:
|
||||
nav2_slam_dir = get_package_share_directory("saltybot_nav2_slam")
|
||||
bringup_dir = get_package_share_directory("saltybot_bringup")
|
||||
nav2_bringup_dir = get_package_share_directory("nav2_bringup")
|
||||
default_map = _default_map()
|
||||
default_params = os.path.join(nav2_slam_dir, "config", "amcl_nav2_params.yaml")
|
||||
map_source = "saved NVMe map" if default_map == _NVME_MAP_YAML else "placeholder map"
|
||||
|
||||
default_map = os.path.join(nav2_slam_dir, "maps", "saltybot_map.yaml")
|
||||
default_params = os.path.join(nav2_slam_dir, "config", "amcl_nav2_params.yaml")
|
||||
|
||||
# ── Launch arguments ──────────────────────────────────────────────────────
|
||||
|
||||
map_arg = DeclareLaunchArgument(
|
||||
"map",
|
||||
default_value=default_map,
|
||||
description="Path to map YAML file (Nav2 map_server format)",
|
||||
)
|
||||
|
||||
use_sim_time_arg = DeclareLaunchArgument(
|
||||
"use_sim_time",
|
||||
default_value="false",
|
||||
description="Use simulated clock from /clock topic",
|
||||
)
|
||||
|
||||
autostart_arg = DeclareLaunchArgument(
|
||||
"autostart",
|
||||
default_value="true",
|
||||
description="Automatically start lifecycle nodes after launch",
|
||||
)
|
||||
|
||||
params_file_arg = DeclareLaunchArgument(
|
||||
"params_file",
|
||||
default_value=default_params,
|
||||
description="Path to Nav2 parameter YAML file",
|
||||
)
|
||||
|
||||
include_sensors_arg = DeclareLaunchArgument(
|
||||
"include_sensors",
|
||||
default_value="true",
|
||||
description="Launch sensors.launch.py (set false if sensors already running)",
|
||||
)
|
||||
|
||||
# ── Substitutions ─────────────────────────────────────────────────────────
|
||||
|
||||
map_file = LaunchConfiguration("map")
|
||||
use_sim_time = LaunchConfiguration("use_sim_time")
|
||||
autostart = LaunchConfiguration("autostart")
|
||||
params_file = LaunchConfiguration("params_file")
|
||||
map_file = LaunchConfiguration("map")
|
||||
use_sim_time = LaunchConfiguration("use_sim_time")
|
||||
autostart = LaunchConfiguration("autostart")
|
||||
params_file = LaunchConfiguration("params_file")
|
||||
include_sensors = LaunchConfiguration("include_sensors")
|
||||
|
||||
# ── Sensor bringup (conditional) ─────────────────────────────────────────
|
||||
# RealSense D435i + RPLIDAR A1M8 drivers + base_link→laser/camera_link TF
|
||||
|
||||
sensors_launch = GroupAction(
|
||||
condition=IfCondition(include_sensors),
|
||||
actions=[
|
||||
LogInfo(msg="[nav2_amcl] Starting sensors (RealSense + RPLIDAR)"),
|
||||
IncludeLaunchDescription(
|
||||
PythonLaunchDescriptionSource(
|
||||
os.path.join(bringup_dir, "launch", "sensors.launch.py")
|
||||
),
|
||||
),
|
||||
],
|
||||
)
|
||||
|
||||
# ── VESC CAN odometry ────────────────────────────────────────────────────
|
||||
# Differential drive from CAN IDs 61 (left) + 79 (right) → /odom + TF
|
||||
|
||||
odom_launch = IncludeLaunchDescription(
|
||||
PythonLaunchDescriptionSource(
|
||||
os.path.join(nav2_slam_dir, "launch", "odometry_bridge.launch.py")
|
||||
),
|
||||
launch_arguments={"use_sim_time": use_sim_time}.items(),
|
||||
)
|
||||
|
||||
# ── Localization: map_server + AMCL ──────────────────────────────────────
|
||||
# Publishes: /map, TF map→odom (AMCL), /amcl_pose, /particlecloud
|
||||
|
||||
localization_launch = IncludeLaunchDescription(
|
||||
PythonLaunchDescriptionSource(
|
||||
os.path.join(nav2_bringup_dir, "launch", "localization_launch.py")
|
||||
),
|
||||
launch_arguments={
|
||||
"map": map_file,
|
||||
"use_sim_time": use_sim_time,
|
||||
"autostart": autostart,
|
||||
"params_file": params_file,
|
||||
"use_lifecycle_mgr": "true",
|
||||
}.items(),
|
||||
)
|
||||
|
||||
# ── Navigation: controller + planner + behaviors + BT navigator ──────────
|
||||
# Subscribes: /odom, /scan, /map, /cmd_vel_nav (→ velocity_smoother → /cmd_vel)
|
||||
# Provides: action servers for NavigateToPose + NavigateThroughPoses
|
||||
|
||||
navigation_launch = IncludeLaunchDescription(
|
||||
PythonLaunchDescriptionSource(
|
||||
os.path.join(nav2_bringup_dir, "launch", "navigation_launch.py")
|
||||
),
|
||||
launch_arguments={
|
||||
"use_sim_time": use_sim_time,
|
||||
"autostart": autostart,
|
||||
"params_file": params_file,
|
||||
"map_subscribe_transient_local": "true",
|
||||
"use_lifecycle_mgr": "true",
|
||||
}.items(),
|
||||
)
|
||||
|
||||
return LaunchDescription([
|
||||
# Arguments
|
||||
map_arg,
|
||||
use_sim_time_arg,
|
||||
autostart_arg,
|
||||
params_file_arg,
|
||||
include_sensors_arg,
|
||||
DeclareLaunchArgument("map_dir", default_value=_NVME_MAP_DIR,
|
||||
description="Directory containing saved map files (Issue #696)"),
|
||||
DeclareLaunchArgument("map", default_value=default_map,
|
||||
description="Path to map YAML. Auto-detected: " + default_map),
|
||||
DeclareLaunchArgument("use_sim_time", default_value="false"),
|
||||
DeclareLaunchArgument("autostart", default_value="true"),
|
||||
DeclareLaunchArgument("params_file", default_value=default_params),
|
||||
DeclareLaunchArgument("include_sensors", default_value="true",
|
||||
description="Launch sensors.launch.py"),
|
||||
|
||||
# Banner
|
||||
LogInfo(msg="[nav2_amcl] Nav2 AMCL bringup starting (Issue #655)"),
|
||||
LogInfo(msg="[nav2_amcl] Nav2 AMCL bringup starting (Issues #655, #696)"),
|
||||
LogInfo(msg="[nav2_amcl] Map: " + map_source + " -> " + default_map),
|
||||
|
||||
GroupAction(
|
||||
condition=IfCondition(include_sensors),
|
||||
actions=[
|
||||
LogInfo(msg="[nav2_amcl] Starting sensors (RealSense + RPLIDAR)"),
|
||||
IncludeLaunchDescription(
|
||||
PythonLaunchDescriptionSource(os.path.join(bringup_dir, "launch", "sensors.launch.py")),
|
||||
),
|
||||
],
|
||||
),
|
||||
|
||||
IncludeLaunchDescription(
|
||||
PythonLaunchDescriptionSource(os.path.join(nav2_slam_dir, "launch", "odometry_bridge.launch.py")),
|
||||
launch_arguments={"use_sim_time": use_sim_time}.items(),
|
||||
),
|
||||
|
||||
# Startup sequence
|
||||
sensors_launch, # step 1 — sensors
|
||||
odom_launch, # step 2 — /odom from VESC
|
||||
LogInfo(msg="[nav2_amcl] Starting AMCL localization"),
|
||||
localization_launch, # step 3 — map_server + AMCL
|
||||
IncludeLaunchDescription(
|
||||
PythonLaunchDescriptionSource(os.path.join(nav2_bringup_dir, "launch", "localization_launch.py")),
|
||||
launch_arguments={
|
||||
"map": map_file, "use_sim_time": use_sim_time,
|
||||
"autostart": autostart, "params_file": params_file,
|
||||
"use_lifecycle_mgr": "true",
|
||||
}.items(),
|
||||
),
|
||||
|
||||
LogInfo(msg="[nav2_amcl] Starting Nav2 navigation stack"),
|
||||
navigation_launch, # step 4 — full nav stack
|
||||
IncludeLaunchDescription(
|
||||
PythonLaunchDescriptionSource(os.path.join(nav2_bringup_dir, "launch", "navigation_launch.py")),
|
||||
launch_arguments={
|
||||
"use_sim_time": use_sim_time, "autostart": autostart,
|
||||
"params_file": params_file,
|
||||
"map_subscribe_transient_local": "true",
|
||||
"use_lifecycle_mgr": "true",
|
||||
}.items(),
|
||||
),
|
||||
])
|
||||
|
||||
@ -1,66 +1,65 @@
|
||||
"""Nav2 SLAM Bringup for SaltyBot (Issue #422)"""
|
||||
"""nav2_slam_bringup.launch.py (Issue #422, #696) — SLAM + map persistence."""
|
||||
|
||||
import os
|
||||
from ament_index_python.packages import get_package_share_directory
|
||||
from launch import LaunchDescription
|
||||
from launch.actions import IncludeLaunchDescription, DeclareLaunchArgument
|
||||
from launch.actions import DeclareLaunchArgument, IncludeLaunchDescription
|
||||
from launch.launch_description_sources import PythonLaunchDescriptionSource
|
||||
from launch.substitutions import LaunchConfiguration
|
||||
from ament_index_python.packages import get_package_share_directory
|
||||
|
||||
|
||||
def generate_launch_description():
|
||||
nav2_slam_dir = get_package_share_directory('saltybot_nav2_slam')
|
||||
bringup_dir = get_package_share_directory('saltybot_bringup')
|
||||
nav2_slam_dir = get_package_share_directory("saltybot_nav2_slam")
|
||||
bringup_dir = get_package_share_directory("saltybot_bringup")
|
||||
nav2_params = os.path.join(nav2_slam_dir, "config", "nav2_params.yaml")
|
||||
slam_params = os.path.join(nav2_slam_dir, "config", "slam_toolbox_params.yaml")
|
||||
|
||||
nav2_params = os.path.join(nav2_slam_dir, 'config', 'nav2_params.yaml')
|
||||
slam_params = os.path.join(nav2_slam_dir, 'config', 'slam_toolbox_params.yaml')
|
||||
use_sim_time = LaunchConfiguration("use_sim_time")
|
||||
map_dir = LaunchConfiguration("map_dir")
|
||||
map_name = LaunchConfiguration("map_name")
|
||||
|
||||
return LaunchDescription([
|
||||
DeclareLaunchArgument('use_sim_time', default_value='false'),
|
||||
|
||||
IncludeLaunchDescription(
|
||||
PythonLaunchDescriptionSource(
|
||||
os.path.join(bringup_dir, 'launch', 'sensors.launch.py')
|
||||
),
|
||||
launch_arguments={'use_sim_time': LaunchConfiguration('use_sim_time')}.items(),
|
||||
DeclareLaunchArgument("use_sim_time", default_value="false"),
|
||||
DeclareLaunchArgument(
|
||||
"map_dir",
|
||||
default_value="/mnt/nvme/saltybot/maps",
|
||||
description="Directory for saving/loading map files (Issue #696)",
|
||||
),
|
||||
|
||||
IncludeLaunchDescription(
|
||||
PythonLaunchDescriptionSource(
|
||||
os.path.join(nav2_slam_dir, 'launch', 'odometry_bridge.launch.py')
|
||||
),
|
||||
launch_arguments={'use_sim_time': LaunchConfiguration('use_sim_time')}.items(),
|
||||
DeclareLaunchArgument(
|
||||
"map_name",
|
||||
default_value="saltybot_map",
|
||||
description="Base filename for saved map (no extension)",
|
||||
),
|
||||
IncludeLaunchDescription(
|
||||
PythonLaunchDescriptionSource(os.path.join(bringup_dir, "launch", "sensors.launch.py")),
|
||||
launch_arguments={"use_sim_time": use_sim_time}.items(),
|
||||
),
|
||||
IncludeLaunchDescription(
|
||||
PythonLaunchDescriptionSource(os.path.join(nav2_slam_dir, "launch", "odometry_bridge.launch.py")),
|
||||
launch_arguments={"use_sim_time": use_sim_time}.items(),
|
||||
),
|
||||
IncludeLaunchDescription(
|
||||
PythonLaunchDescriptionSource(os.path.join(nav2_slam_dir, "launch", "nav2_slam_integrated.launch.py")),
|
||||
launch_arguments={"slam_params_file": slam_params, "use_sim_time": use_sim_time}.items(),
|
||||
),
|
||||
IncludeLaunchDescription(
|
||||
PythonLaunchDescriptionSource(os.path.join(nav2_slam_dir, "launch", "depth_to_costmap.launch.py")),
|
||||
launch_arguments={"use_sim_time": use_sim_time}.items(),
|
||||
),
|
||||
|
||||
IncludeLaunchDescription(
|
||||
PythonLaunchDescriptionSource(
|
||||
os.path.join(nav2_slam_dir, 'launch', 'nav2_slam_integrated.launch.py')
|
||||
os.path.join(get_package_share_directory("nav2_bringup"), "launch", "navigation_launch.py")
|
||||
),
|
||||
launch_arguments={
|
||||
'slam_params_file': slam_params,
|
||||
'use_sim_time': LaunchConfiguration('use_sim_time'),
|
||||
"use_sim_time": use_sim_time,
|
||||
"params_file": nav2_params,
|
||||
"autostart": "true",
|
||||
"map_subscribe_transient_local": "true",
|
||||
}.items(),
|
||||
),
|
||||
|
||||
# Map persistence (Issue #696): map_saver_server + /saltybot/save_map service
|
||||
IncludeLaunchDescription(
|
||||
PythonLaunchDescriptionSource(
|
||||
os.path.join(nav2_slam_dir, 'launch', 'depth_to_costmap.launch.py')
|
||||
),
|
||||
launch_arguments={'use_sim_time': LaunchConfiguration('use_sim_time')}.items(),
|
||||
),
|
||||
|
||||
IncludeLaunchDescription(
|
||||
PythonLaunchDescriptionSource(
|
||||
os.path.join(
|
||||
get_package_share_directory('nav2_bringup'),
|
||||
'launch', 'navigation_launch.py'
|
||||
)
|
||||
),
|
||||
launch_arguments={
|
||||
'use_sim_time': LaunchConfiguration('use_sim_time'),
|
||||
'params_file': nav2_params,
|
||||
'autostart': 'true',
|
||||
'map_subscribe_transient_local': 'true',
|
||||
}.items(),
|
||||
PythonLaunchDescriptionSource(os.path.join(nav2_slam_dir, "launch", "map_persistence.launch.py")),
|
||||
launch_arguments={"map_dir": map_dir, "map_name": map_name, "use_sim_time": use_sim_time}.items(),
|
||||
),
|
||||
])
|
||||
|
||||
@ -0,0 +1,145 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
map_saver_node.py — Map persistence helper for SLAM → AMCL hand-off (Issue #696).
|
||||
|
||||
Responsibilities:
|
||||
1. On startup: report whether a saved map exists at map_dir/map_name.yaml
|
||||
(the path that nav2_amcl_bringup.launch.py will load on next boot).
|
||||
2. Provide /saltybot/save_map (std_srvs/Trigger) — triggers map_saver_cli
|
||||
to save the current /map topic to map_dir/map_name.{yaml,pgm}.
|
||||
3. On shutdown: if auto_save_on_shutdown is true, save the final map.
|
||||
|
||||
Parameters:
|
||||
map_dir (str) default /mnt/nvme/saltybot/maps
|
||||
map_name (str) default saltybot_map
|
||||
auto_save_on_shutdown (bool) default true
|
||||
|
||||
The saved map is loaded automatically by nav2_amcl_bringup.launch.py on the
|
||||
next startup when the file is present at map_dir/map_name.yaml.
|
||||
"""
|
||||
|
||||
import os
|
||||
import subprocess
|
||||
|
||||
import rclpy
|
||||
from rclpy.node import Node
|
||||
from std_srvs.srv import Trigger
|
||||
|
||||
|
||||
class MapSaverNode(Node):
|
||||
"""Helper node for SLAM map persistence and AMCL pre-load."""
|
||||
|
||||
def __init__(self) -> None:
|
||||
super().__init__("saltybot_map_saver")
|
||||
|
||||
self.declare_parameter("map_dir", "/mnt/nvme/saltybot/maps")
|
||||
self.declare_parameter("map_name", "saltybot_map")
|
||||
self.declare_parameter("auto_save_on_shutdown", True)
|
||||
|
||||
self._map_dir = self.get_parameter("map_dir").value
|
||||
self._map_name = self.get_parameter("map_name").value
|
||||
self._auto_save = self.get_parameter("auto_save_on_shutdown").value
|
||||
|
||||
self._map_prefix = os.path.join(self._map_dir, self._map_name)
|
||||
self._map_yaml = self._map_prefix + ".yaml"
|
||||
|
||||
# ── Ensure map directory exists ────────────────────────────────────────
|
||||
os.makedirs(self._map_dir, exist_ok=True)
|
||||
|
||||
# ── Report saved map status ────────────────────────────────────────────
|
||||
if os.path.isfile(self._map_yaml):
|
||||
self.get_logger().info(
|
||||
f"[map_saver] Saved map found: {self._map_yaml} — "
|
||||
"AMCL will load this map on next startup."
|
||||
)
|
||||
else:
|
||||
self.get_logger().warn(
|
||||
f"[map_saver] No saved map at {self._map_yaml} — "
|
||||
"AMCL will use the placeholder map. "
|
||||
"Run SLAM, then call /saltybot/save_map to persist."
|
||||
)
|
||||
|
||||
# ── Service: /saltybot/save_map ────────────────────────────────────────
|
||||
self._save_srv = self.create_service(
|
||||
Trigger,
|
||||
"/saltybot/save_map",
|
||||
self._on_save_map,
|
||||
)
|
||||
|
||||
self.get_logger().info(
|
||||
f"[map_saver] Ready. map_dir={self._map_dir} map_name={self._map_name} "
|
||||
f"auto_save_on_shutdown={self._auto_save}"
|
||||
)
|
||||
|
||||
# ── Service callback ───────────────────────────────────────────────────────
|
||||
|
||||
def _on_save_map(
|
||||
self, _request: Trigger.Request, response: Trigger.Response
|
||||
) -> Trigger.Response:
|
||||
"""Save current /map to map_dir/map_name.{yaml,pgm} via map_saver_cli."""
|
||||
success, message = self._save_map()
|
||||
response.success = success
|
||||
response.message = message
|
||||
return response
|
||||
|
||||
# ── Map save helper ────────────────────────────────────────────────────────
|
||||
|
||||
def _save_map(self) -> tuple[bool, str]:
|
||||
"""
|
||||
Call nav2_map_server map_saver_cli to write the current /map.
|
||||
|
||||
Returns (success, message).
|
||||
"""
|
||||
cmd = [
|
||||
"ros2", "run", "nav2_map_server", "map_saver_cli",
|
||||
"-f", self._map_prefix,
|
||||
"--map_subscribe_transient_local",
|
||||
]
|
||||
self.get_logger().info(f"[map_saver] Saving map to {self._map_prefix}.*")
|
||||
try:
|
||||
result = subprocess.run(
|
||||
cmd,
|
||||
timeout=10,
|
||||
capture_output=True,
|
||||
text=True,
|
||||
)
|
||||
if result.returncode == 0:
|
||||
msg = f"Map saved to {self._map_yaml}"
|
||||
self.get_logger().info(f"[map_saver] {msg}")
|
||||
return True, msg
|
||||
else:
|
||||
msg = f"map_saver_cli failed (rc={result.returncode}): {result.stderr.strip()}"
|
||||
self.get_logger().error(f"[map_saver] {msg}")
|
||||
return False, msg
|
||||
except subprocess.TimeoutExpired:
|
||||
msg = "map_saver_cli timed out after 10 s (is /map published?)"
|
||||
self.get_logger().error(f"[map_saver] {msg}")
|
||||
return False, msg
|
||||
except Exception as exc: # noqa: BLE001
|
||||
msg = f"map_saver_cli exception: {exc}"
|
||||
self.get_logger().error(f"[map_saver] {msg}")
|
||||
return False, msg
|
||||
|
||||
# ── Lifecycle ──────────────────────────────────────────────────────────────
|
||||
|
||||
def destroy_node(self) -> None:
|
||||
if self._auto_save:
|
||||
self.get_logger().info("[map_saver] Shutdown — auto-saving map...")
|
||||
self._save_map()
|
||||
super().destroy_node()
|
||||
|
||||
|
||||
def main(args=None) -> None:
|
||||
rclpy.init(args=args)
|
||||
node = MapSaverNode()
|
||||
try:
|
||||
rclpy.spin(node)
|
||||
except KeyboardInterrupt:
|
||||
pass
|
||||
finally:
|
||||
node.destroy_node()
|
||||
rclpy.shutdown()
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
@ -15,6 +15,7 @@ setup(
|
||||
"launch/depth_to_costmap.launch.py",
|
||||
"launch/odometry_bridge.launch.py",
|
||||
"launch/nav2_amcl_bringup.launch.py",
|
||||
"launch/map_persistence.launch.py",
|
||||
]),
|
||||
(f"share/{package_name}/config", [
|
||||
"config/nav2_params.yaml",
|
||||
@ -25,6 +26,7 @@ setup(
|
||||
"config/dwb_local_planner_params.yaml",
|
||||
"config/vesc_odometry_params.yaml",
|
||||
"config/amcl_nav2_params.yaml",
|
||||
"config/map_saver_params.yaml",
|
||||
]),
|
||||
(f"share/{package_name}/maps", [
|
||||
"maps/saltybot_map.yaml",
|
||||
@ -42,6 +44,7 @@ setup(
|
||||
"console_scripts": [
|
||||
"vesc_odometry_bridge = saltybot_nav2_slam.vesc_odometry_bridge:main",
|
||||
"vesc_can_odometry = saltybot_nav2_slam.vesc_odometry_bridge:main",
|
||||
"map_saver_node = saltybot_nav2_slam.map_saver_node:main",
|
||||
],
|
||||
},
|
||||
)
|
||||
|
||||
@ -334,5 +334,125 @@ def test_launch_file_has_map_argument():
|
||||
assert '"map"' in src or "'map'" in src
|
||||
|
||||
|
||||
|
||||
# ── map_saver_params.yaml + map_persistence files (Issue #696) ───────────────
|
||||
|
||||
import os as _os
|
||||
_PKG_ROOT2 = _os.path.join(_os.path.dirname(__file__), "..")
|
||||
_MAP_SAVER_CFG = _os.path.join(_PKG_ROOT2, "config", "map_saver_params.yaml")
|
||||
_SLAM_LAUNCH = _os.path.join(_PKG_ROOT2, "launch", "nav2_slam_bringup.launch.py")
|
||||
_PERSIST_LAUNCH = _os.path.join(_PKG_ROOT2, "launch", "map_persistence.launch.py")
|
||||
_SAVER_NODE = _os.path.join(_PKG_ROOT2, "saltybot_nav2_slam", "map_saver_node.py")
|
||||
|
||||
|
||||
def _load_map_saver_params():
|
||||
import yaml
|
||||
with open(_MAP_SAVER_CFG) as f:
|
||||
return yaml.safe_load(f)
|
||||
|
||||
|
||||
def test_map_saver_params_file_exists():
|
||||
assert _os.path.isfile(_MAP_SAVER_CFG)
|
||||
|
||||
|
||||
def test_map_saver_params_required_keys():
|
||||
p = _load_map_saver_params()["map_saver"]["ros__parameters"]
|
||||
for key in ("save_map_timeout", "free_thresh_default",
|
||||
"occupied_thresh_default", "map_subscribe_transient_local"):
|
||||
assert key in p, f"map_saver_params missing: {key}"
|
||||
|
||||
|
||||
def test_map_saver_thresholds_valid():
|
||||
p = _load_map_saver_params()["map_saver"]["ros__parameters"]
|
||||
assert 0.0 < p["free_thresh_default"] < p["occupied_thresh_default"] < 1.0
|
||||
|
||||
|
||||
def test_map_saver_timeout_positive():
|
||||
p = _load_map_saver_params()["map_saver"]["ros__parameters"]
|
||||
assert p["save_map_timeout"] > 0.0
|
||||
|
||||
|
||||
def test_map_persistence_launch_exists():
|
||||
assert _os.path.isfile(_PERSIST_LAUNCH)
|
||||
|
||||
|
||||
def test_map_persistence_launch_syntax():
|
||||
import py_compile
|
||||
py_compile.compile(_PERSIST_LAUNCH, doraise=True)
|
||||
|
||||
|
||||
def test_map_persistence_launch_has_map_saver_server():
|
||||
with open(_PERSIST_LAUNCH) as f:
|
||||
src = f.read()
|
||||
assert "map_saver_server" in src
|
||||
|
||||
|
||||
def test_map_persistence_launch_has_lifecycle_manager():
|
||||
with open(_PERSIST_LAUNCH) as f:
|
||||
src = f.read()
|
||||
assert "lifecycle_manager" in src
|
||||
|
||||
|
||||
def test_map_persistence_launch_has_map_dir_arg():
|
||||
with open(_PERSIST_LAUNCH) as f:
|
||||
src = f.read()
|
||||
assert "map_dir" in src
|
||||
|
||||
|
||||
def test_map_saver_node_exists():
|
||||
assert _os.path.isfile(_SAVER_NODE)
|
||||
|
||||
|
||||
def test_map_saver_node_syntax():
|
||||
import py_compile
|
||||
py_compile.compile(_SAVER_NODE, doraise=True)
|
||||
|
||||
|
||||
def test_map_saver_node_has_save_service():
|
||||
with open(_SAVER_NODE) as f:
|
||||
src = f.read()
|
||||
assert "/saltybot/save_map" in src
|
||||
|
||||
|
||||
def test_map_saver_node_calls_map_saver_cli():
|
||||
with open(_SAVER_NODE) as f:
|
||||
src = f.read()
|
||||
assert "map_saver_cli" in src
|
||||
|
||||
|
||||
def test_map_saver_node_has_auto_save_shutdown():
|
||||
with open(_SAVER_NODE) as f:
|
||||
src = f.read()
|
||||
assert "auto_save_on_shutdown" in src
|
||||
|
||||
|
||||
def test_slam_bringup_includes_map_persistence():
|
||||
with open(_SLAM_LAUNCH) as f:
|
||||
src = f.read()
|
||||
assert "map_persistence.launch.py" in src
|
||||
|
||||
|
||||
def test_slam_bringup_has_map_dir_arg():
|
||||
with open(_SLAM_LAUNCH) as f:
|
||||
src = f.read()
|
||||
assert "map_dir" in src
|
||||
|
||||
|
||||
def test_amcl_launch_has_map_dir_arg():
|
||||
import os as __os
|
||||
_LAUNCH2 = __os.path.join(__os.path.dirname(__file__), "..", "launch", "nav2_amcl_bringup.launch.py")
|
||||
with open(_LAUNCH2) as f:
|
||||
src = f.read()
|
||||
assert "map_dir" in src
|
||||
|
||||
|
||||
def test_amcl_launch_has_auto_detect_logic():
|
||||
import os as __os
|
||||
_LAUNCH2 = __os.path.join(__os.path.dirname(__file__), "..", "launch", "nav2_amcl_bringup.launch.py")
|
||||
with open(_LAUNCH2) as f:
|
||||
src = f.read()
|
||||
assert "/mnt/nvme/saltybot/maps" in src
|
||||
assert "isfile" in src or "os.path" in src
|
||||
|
||||
if __name__ == "__main__":
|
||||
pytest.main([__file__, "-v"])
|
||||
|
||||
@ -293,11 +293,51 @@ function drawCompass(yaw) {
|
||||
|
||||
// ── ROS connection ────────────────────────────────────────────────────────────
|
||||
|
||||
function connect(url) {
|
||||
// ── Auto-reconnect state ──────────────────────────────────────────────────────
|
||||
|
||||
const RECONNECT_BASE_MS = 2000;
|
||||
const RECONNECT_MAX_MS = 30000;
|
||||
const RECONNECT_FACTOR = 1.5;
|
||||
|
||||
let reconnectDelay = RECONNECT_BASE_MS;
|
||||
let reconnectTimer = null;
|
||||
let reconnectTick = null;
|
||||
let reconnectTarget = null;
|
||||
|
||||
function cancelReconnect() {
|
||||
if (reconnectTimer) { clearTimeout(reconnectTimer); reconnectTimer = null; }
|
||||
if (reconnectTick) { clearInterval(reconnectTick); reconnectTick = null; }
|
||||
}
|
||||
|
||||
function scheduleReconnect(url) {
|
||||
cancelReconnect();
|
||||
let secs = Math.round(reconnectDelay / 1000);
|
||||
$('conn-label').textContent = `Retry in ${secs}s…`;
|
||||
|
||||
reconnectTick = setInterval(() => {
|
||||
secs = Math.max(0, secs - 1);
|
||||
if (secs > 0) $('conn-label').textContent = `Retry in ${secs}s…`;
|
||||
}, 1000);
|
||||
|
||||
reconnectTimer = setTimeout(() => {
|
||||
reconnectTimer = null;
|
||||
connect(url, true);
|
||||
}, reconnectDelay);
|
||||
|
||||
reconnectDelay = Math.min(reconnectDelay * RECONNECT_FACTOR, RECONNECT_MAX_MS);
|
||||
}
|
||||
|
||||
function connect(url, isAutoRetry) {
|
||||
cancelReconnect();
|
||||
reconnectTarget = url;
|
||||
if (!isAutoRetry) reconnectDelay = RECONNECT_BASE_MS;
|
||||
|
||||
if (ros) { try { ros.close(); } catch(_) {} }
|
||||
ros = new ROSLIB.Ros({ url });
|
||||
|
||||
ros.on('connection', () => {
|
||||
reconnectDelay = RECONNECT_BASE_MS;
|
||||
cancelReconnect();
|
||||
$('conn-dot').className = 'connected';
|
||||
$('conn-label').style.color = '#22c55e';
|
||||
$('conn-label').textContent = 'Connected';
|
||||
@ -315,7 +355,7 @@ function connect(url) {
|
||||
ros.on('close', () => {
|
||||
$('conn-dot').className = '';
|
||||
$('conn-label').style.color = '#6b7280';
|
||||
$('conn-label').textContent = 'Disconnected';
|
||||
scheduleReconnect(reconnectTarget || $('ws-input').value.trim());
|
||||
});
|
||||
}
|
||||
|
||||
@ -405,8 +445,8 @@ function setupTopics() {
|
||||
|
||||
// ── UI wiring ─────────────────────────────────────────────────────────────────
|
||||
|
||||
$('btn-connect').addEventListener('click', () => connect($('ws-input').value.trim()));
|
||||
$('ws-input').addEventListener('keydown', e => { if (e.key === 'Enter') connect($('ws-input').value.trim()); });
|
||||
$('btn-connect').addEventListener('click', () => connect($('ws-input').value.trim(), false));
|
||||
$('ws-input').addEventListener('keydown', e => { if (e.key === 'Enter') connect($('ws-input').value.trim(), false); });
|
||||
|
||||
// ── Auto-connect on load ──────────────────────────────────────────────────────
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user