BaseFlight CLI - FabLabSeoul/WingProject GitHub Wiki

Multiwii BaseFlight CLI (Command Line Interface)

CLI는 짧은 명령어로 쿼드콥터의 상태를 알아오고, 값을 설정하는 용도로 쓰인다. 쉽게 말하면, 예전 DOS창 터미널에서 명령어를 입력하는 것과 똑같다.

Naze32 보드를 그대로 사용한다면, CleanFlight나 BaseFlight 프로그램을 사용해서 보드의 상태를 알면되니, 굳이 CLI를 건들 일이 없다. 그러나 BaseFlight 코드를 수정하거나, 추가 기능을 넣고자 한다면, 기존 BaseFlight모니터링 프로그램으로는 한계가 있다.

날개 프로젝트에서는 Naze32 보드의 상태(자세정보, 모터추력정보)를 알아오고, 추가한 소스코드의 변수를 체크하기위해 CLI 프로토콜을 수정해야 했다.

우선 BaseFlight의 CLI 분석해보자.

Naze32에서 CLI는 시리얼통신으로 정보를 주고 받는다. 보드에 USB가 꼽혀있다면, USB를 통해 시리얼 통신으로 CLI를 이용할 수 있다. Baseflight에서는 serial.h, serial.c, cli.h, cli.c 에서 이 기능을 구현하고 있다. 보드와 CLI통신을 하는 간단한 예제는 WingProject\VisualStudio\Naze32SerialCom 에서 확인할 수 있다.

보드에 USB를 꼽지 않고, CLI 통신하고 싶을 때는 BaseFlight External Serial 문서를 참조하자.

명령어를 전송하면, 그에 대한 결과값을 보드에서 보내준다.

명령어 전송

• Protocol
  • $
  • M
  • <
  • 전송할 데이타 크기 (바이트단위)
  • 명령어 BaseFlight CLI Command
  • 전송할 데이타1
  • 전송할 데이타2
  • ...
  • 전송할 데이타n (전송할 데이타 개수만큼)
  • 체크섬
    • 전송할 데이타 크기 값 부터 이후 모든 정보를 xor 한 값.

void SendCommand(CBufferedSerial &serial, const unsigned char cmd)
{
	unsigned char packet[64];
	int checksum = 0;
	int idx = 0;
	packet[idx++] = '$';
	packet[idx++] = 'M';
	packet[idx++] = '<';
	packet[idx++] = 0;
	checksum ^= 0;
	packet[idx++] = cmd;
	checksum ^= cmd;
	packet[idx++] = checksum;
	serial.SendData((char*)packet, idx);
}

명령어 수신

• Protocol
  • $
  • M
  • 수신할 데이타 크기 (바이트단위)
  • 명령어 BaseFlight CLI Command
  • 수신 데이타1
  • 수신 데이타2
  • ...
  • 수신 데이타n (수신 데이타 개수만큼)
  • 체크섬
    • 수신한 데이타 크기 값 부터 이후 모든 정보를 xor 한 값.

// 간단한 스테이트 머신으로 구현되었다.
void RecvCommand(CBufferedSerial &serial)
{
	int state = 0;
	int len = 0;
	int readLen = 0;
	int msp = 0;
	int noDataCnt = 0;
	int checkSum = 0;
	while (1)
	{
		unsigned char c;
		if (serial.ReadData(&c, 1) <= 0)
		{
			Sleep(1);
			++noDataCnt;
			if (noDataCnt > 500)
				break; // exception
			continue;
		}

		switch (state)
		{
		case 0:
		{
			state = (c == '$') ? 1 : 0;
			cout << c;
		}
		break;
		
		case 1:
		{
			state = (c == 'M') ? 2 : 0;
			cout << c;
		}
		break;

		case 2:
		{
			state = (c == '>') ? 3 : 0;
			cout << c;
		}
		break;

		case 3:
		{
			len = c;
			cout << (int)c;
			checkSum ^= c;
			state = 4;
		}
		break;

		case 4:
		{
			msp = c;
			cout << (int)c << " ";
			checkSum ^= c;
			state = 5;
		}
		break;

		case 5:
		{
			if (len > readLen)
			{
				checkSum ^= c;
				cout << (int)c << " ";
			}
			else
			{
				if (checkSum == c)
				{
					cout << "ok" << endl;
					return; // end;
				}
				else
				{
					cout << "error!!" << endl;
					return; // end;
				}
			}

			++readLen;
		}
		break;

		default:
			break;
		}
	}
}