컴포넌트와 sf-pkg¶

SiFli 프로젝트는 재사용 가능한 미들웨어, 드라이버, 컴포넌트에 의존하는 경우가 많습니다. 프로젝트가 단순히 예제를 복사해 쓰는 단계를 넘어가면 SiFli의 패키지/컴포넌트 에코시스템을 활용해 재사용 가능한 펌웨어 구성 요소를 배포하고 유지 관리하십시오.

컴포넌트를 바라보는 방법¶

여러 제품이나 예제에서 공유해야 하는 코드에는 컴포넌트를 사용하십시오.

• 주변 장치 드라이버.
• 디스플레이 패널 지원.
• Bluetooth 서비스.
• GUI 위젯.
• 센서 어댑터.
• 스토리지 헬퍼.
• 제품 미들웨어.

일회성 애플리케이션 로직은 인터페이스가 안정되고 여러 사용처에서 재사용될 때까지 애플리케이션 프로젝트에 두십시오.

실무 워크플로¶

1. 동작하는 SDK 예제에서 시작합니다.
2. 재사용 가능해야 하는 부분을 식별합니다.
3. 범위가 명확한 작은 API로 노출합니다.
4. SDK의 일반적인 빌드/설정 메커니즘으로 설정을 추가합니다.
5. 의존성, 메모리 사용량, 필요한 주변 장치를 문서화합니다.
6. 그런 다음에야 재사용 가능한 컴포넌트로 패키징합니다.

sf-pkg로 컴포넌트 배포하기¶

컴포넌트는 재사용 가능한 개발 단위입니다. SiFli의 컴포넌트 레지스트리는 Conan을 기반으로 하며, 현재 SDK 명령줄 하위 명령은 sf-pkg입니다.

패키지를 사용하려면 SDK 프로젝트의 project 디렉터리에서 sdk.py sf-pkg init을 실행하여 conanfile.py를 생성합니다. 패키지 레지스트리의 사용자 이름을 사용하여 requires 필드에 package/version@<username> 형식으로 패키지 참조를 추가합니다. 그런 다음 같은 디렉터리에서 sdk.py sf-pkg install을 실행합니다. 설치된 패키지는 project/sf-pkgs에 배치되며, 해당 Kconfig 파일은 menuconfig의 SiFli External Components 아래에 포함됩니다.

컴포넌트를 게시하려면 해당 디렉터리에서 sdk.py sf-pkg new --name <package_name>을 실행하고 생성된 conanfile.py를 검토하십시오. 생성 시 --support-sdk-version <sdk_version_range>를 전달해 범위를 지정할 수 있습니다. 이 옵션을 사용했는지와 관계없이 레시피의 support_sdk_version에 의도한 SDK 호환 범위가 선언되어 있는지 확인하고 필요하면 조정하십시오. 시맨틱 버전 규칙에 맞는 패키지 버전을 선택하고 메타데이터와 의존성을 작성하십시오. 레지스트리에 인증한 다음 패키지를 빌드하고 업로드합니다.

sdk.py sf-pkg build --version <version>
sdk.py sf-pkg upload --name <package_name>/<version>@<username>

정확한 워크플로는 SDK 릴리스에 따라 다를 수 있습니다. 설정, 인증, 버전별 세부 사항은 SiFli의 패키지 통합 가이드(중국어), 패키지 생성 및 게시 가이드(영어), 중국어판을 참조하십시오.

컴포넌트 품질 기준¶

컴포넌트는 다음 조건을 갖추었을 때 공유할 준비가 된 것입니다.

• 설정과 의존성이 문서화되어 있으며 클린 체크아웃 상태에서 빌드할 수 있습니다.
• 최소한의 예제가 하나 있습니다.
• 필요한 설정이 문서화되어 있습니다.
• 보드에 대한 암묵적 가정을 피합니다.
• 오류를 명확하게 보고합니다.
• 소유권과 해제 규칙을 포함하여 전역 리소스의 사용을 문서화합니다.
• 스레드, 콜백, 메모리 소유권 규칙을 명시합니다.

기록할 내용¶

재사용 가능한 컴포넌트에는 다음 내용을 문서화하는 것이 좋습니다.

• 지원되는 칩과 보드.
• 필요한 SDK 버전.
• 필요한 주변 장치와 핀.
• 필요한 RTOS/미들웨어 설정.
• 스레딩 및 콜백 동작.
• RAM, 플래시, 스택 요구량.
• 예제 프로젝트 경로.

피해야 할 함정¶

최종 업데이트: 2026-10-19