Skip to content

Commit

Permalink
Merge pull request #4 from CTA-Ripple/rc-v2.0.0
Browse files Browse the repository at this point in the history
Ripple API v2.0.0
  • Loading branch information
CTA-Ripple committed Jun 16, 2023
2 parents c608d60 + e034f9d commit 7153950
Show file tree
Hide file tree
Showing 17 changed files with 3,173 additions and 1,649 deletions.
3 changes: 3 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Placeholder to control git attributes.
* text=auto eol=lf

67 changes: 67 additions & 0 deletions .github/workflows/presubmit.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
name: Presubmit check

on:

workflow_dispatch:

push:
branches:
- main
- develop

pull_request:
branches:
- main
- develop

env:
# Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.)
BUILD_TYPE: Release

jobs:

example-c-hello-world:
runs-on: ubuntu-latest

env:
PROJECT_PATH: ${{github.workspace}}/example/c/hello-world
PROJECT_NAME: HelloWorld C example

steps:
- uses: actions/checkout@v3

- name: Configure ${{env.PROJECT_NAME}}
working-directory: ${{env.PROJECT_PATH}}
run: cmake -B build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}}

- name: Build ${{env.PROJECT_NAME}}
working-directory: ${{env.PROJECT_PATH}}
run: cmake --build build --config ${{env.BUILD_TYPE}}

example-cpp-hello-world:
runs-on: ubuntu-latest

env:
PROJECT_PATH: ${{github.workspace}}/example/cpp/hello-world
PROJECT_NAME: HelloWorld C++ example

steps:
- uses: actions/checkout@v3

- name: Configure ${{env.PROJECT_NAME}}
working-directory: ${{env.PROJECT_PATH}}
run: cmake -B build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}}

- name: Build ${{env.PROJECT_NAME}}
working-directory: ${{env.PROJECT_PATH}}
run: cmake --build build --config ${{env.BUILD_TYPE}}

build:
runs-on: ubuntu-latest
needs:
- example-c-hello-world
- example-cpp-hello-world

steps:
- name: Main build job
run: cmake --version
24 changes: 24 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# v2.0.0

* Add API support for pulsed and UWB radar
* Add cpp example with stub driver
* Move C example to a subdir, link with stub radar
* Move platform items out of example
* Add a C++ stub radar driver
* Add a C stub radar driver
* Fixed Variadic macros
* Pass log level as RadarLogLevel instead of int
* Add virtual dtor for C++ interfaces
* Add API to get maximum number of active configs
* Add radar type
* Separate API to get Ripple API version
* Add API to retrieve TX/RX layout
* Add GetVendorParamRange API
* Add Create/Destroy RadarSensor API
* Move bit fields in BurstFormat to bools
* Remove FIFO related API
* Fix SensorInfo members' type
* Make LogSensorDetails as pure virtual function
* Bring source code to unix format

# v1.1.1
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Ripple

This repo contains the public releases of the Ripple API code and example programs. For more information contact ripple@cta.tech.
This repo contains the public releases of the Ripple API code and example programs. For more information contact ripple@cta.tech.

See https://shop.cta.tech/collections/standards/products/https-cdn-cta-tech-cta-media-media-shop-standards-2020-ripple-radar-sensor-api-standard-v1-1-final-pdf for the associated Specification.

Expand Down
27 changes: 27 additions & 0 deletions example/c/hello-world/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
cmake_minimum_required(VERSION 3.13)

### General settings ###
project(hello-world VERSION 1.0.0)
set(root_dir ${CMAKE_CURRENT_LIST_DIR}/../../..)

### Add source files ###
add_executable(${PROJECT_NAME}
main.c
${root_dir}/radars/c/stub/main.c
)

set_property(TARGET ${PROJECT_NAME} PROPERTY C_STANDARD 99)


### Add include folders ###
include_directories(
${root_dir}/radar-api
${root_dir}/radars/c/stub
${root_dir}/platform
)

target_compile_options(${PROJECT_NAME} PRIVATE
$<$<OR:$<C_COMPILER_ID:GNU>,$<C_COMPILER_ID:Clang>,$<C_COMPILER_ID:AppleClang>>:
-Wall -Werror -Wextra -pedantic -pedantic-errors>
$<$<C_COMPILER_ID:MSVC>:
/W4>)
Loading

0 comments on commit 7153950

Please sign in to comment.