Skip to content

Commit 1214794

Browse files
Release v4.1.1 of Boston Dynamics Spot SDK (#13)
Co-authored-by: Boston Dynamics SDK Publisher <[email protected]>
1 parent b167486 commit 1214794

40 files changed

+146
-74
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The official Spot SDK documentation also contains information relevant to the C+
2121
- [Payload developer documentation](https://dev.bostondynamics.com/docs/payload/readme). Payloads add additional sensing, communication, and control capabilities beyond what the base platform provides. The Payload ICD covers the mechanical, electrical, and software interfaces that Spot supports.
2222
- [Spot API protocol definition](https://dev.bostondynamics.com/docs/protos/readme). This reference guide covers the details of the protocol applications used to communicate to Spot. Application developers who wish to use a language other than Python can implement clients that speak the protocol.
2323

24-
This is version 4.1.0 of the C++ SDK. Please review the [Release Notes](docs/cpp_release_notes.md) to see what has changed.
24+
This is version 4.1.1 of the C++ SDK. Please review the [Release Notes](docs/cpp_release_notes.md) to see what has changed.
2525

2626
## Contents
2727

cpp/CMakeLists.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
# This file is autogenerated.
88

99
cmake_minimum_required (VERSION 3.10.2)
10-
project (bosdyn VERSION 4.1.0)
10+
project (bosdyn VERSION 4.1.1)
1111

1212
# Dependencies:
1313
find_package(Protobuf REQUIRED)

cpp/bosdyn/client/README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,22 @@ Development Kit License (20191101-BDSDK-SL).
88

99
# Client Classes
1010

11-
The bosdyn/client folder contains client interfaces for interacting with the Boston Dynamics Spot
12-
API. The client interfaces implement the Remote Procedure Calls (RPCs) in the
11+
The bosdyn/client folder contains client interfaces for interacting with the Boston Dynamics Spot
12+
API. The client interfaces implement the Remote Procedure Calls (RPCs) in the
1313
[API protobuf definitions](https://dev.bostondynamics.com/protos/bosdyn/api/readme).
1414

1515
## Main Classes
16+
1617
The main classes contained in this folder are ClientSdk and Robot.
17-
* **ClientSdk**: Class for settings typically common to a single developer and/or robot fleet.
18-
* **Robot**: Class for settings common to one user's access to one robot. This is the main point
19-
of access to all client functionality.
2018

21-
For example, to list the robot image sources using the Image client, simply create an Sdk object,
22-
create a Robot object, authenticate, create the client and call the
19+
- **ClientSdk**: Class for settings typically common to a single developer and/or robot fleet.
20+
- **Robot**: Class for settings common to one user's access to one robot. This is the main point
21+
of access to all client functionality.
22+
23+
For example, to list the robot image sources using the Image client, simply create an Sdk object,
24+
create a Robot object, authenticate, create the client and call the
2325
corresponding method, as shown below. It is that simple!
26+
2427
```
2528
auto client_sdk = ::bosdyn::client::CreateStandardSDK("hello_spot");
2629
auto robot = client_sdk->CreateRobot("10.0.0.3").move();
@@ -29,5 +32,5 @@ auto image_client = robot->EnsureServiceClient<::bosdyn::client::ImageClient>().
2932
auto result = image_client->ListImageSources().move();
3033
```
3134

32-
Clients that trigger robot movement also need to set up the TimeSync, Lease and E-Stop clients. Our
33-
[Python examples](https://github.com/boston-dynamics/spot-sdk/tree/master/python/examples) repository contains many tutorials on how to use the clients. The API for the Spot Python SDK is very similar to the API for the Spot C++ SDK, and most Python examples can be used as reference on how to implement C++ applications. The Spot C++ SDK contains examples as well, listed [here](../../examples/README.md).
35+
Clients that trigger robot movement also need to set up the TimeSync, Lease and E-Stop clients. Our
36+
[Python examples](https://github.com/boston-dynamics/spot-sdk/tree/master/python/examples) repository contains many tutorials on how to use the clients. The API for the Spot Python SDK is very similar to the API for the Spot C++ SDK, and most Python examples can be used as reference on how to implement C++ applications. The Spot C++ SDK contains examples as well, listed [here](../../examples/README.md).

cpp/bosdyn/client/directory/directory_helpers.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99

1010
#include "directory_helpers.h"
1111

12-
#include "bosdyn/client/sdk/client_sdk.h"
1312
#include "bosdyn/client/error_codes/directory_helper_error_code.h"
13+
#include "bosdyn/client/sdk/client_sdk.h"
1414

1515
namespace bosdyn {
1616

cpp/bosdyn/client/directory_registration/directory_registration_helpers.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@
1313
#include <thread>
1414

1515
#include "directory_registration_client.h"
16-
#include "bosdyn/client/service_client/common_result_types.h"
1716
#include "bosdyn/client/fault/fault_client.h"
17+
#include "bosdyn/client/service_client/common_result_types.h"
1818

1919
#include <bosdyn/api/directory.pb.h>
2020

cpp/bosdyn/client/error_codes/error_type_condition.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@
99

1010
#include <iostream>
1111

12+
#include "bosdyn/client/error_codes/error_type_condition.h"
1213
#include "bosdyn/client/error_codes/rpc_error_code.h"
1314
#include "bosdyn/client/error_codes/sdk_error_code.h"
14-
#include "bosdyn/client/error_codes/error_type_condition.h"
1515

1616
namespace { // anonymous namespace
1717

cpp/bosdyn/client/error_codes/time_sync_helper_error_code.cpp

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88

99

1010
#include "bosdyn/client/error_codes/time_sync_helper_error_code.h"
11-
#include "bosdyn/client/error_codes/sdk_error_code.h"
1211
#include "bosdyn/client/error_codes/error_type_condition.h"
12+
#include "bosdyn/client/error_codes/sdk_error_code.h"
1313
#include "bosdyn/common/success_condition.h"
1414

1515
namespace bosdyn {
@@ -25,13 +25,15 @@ struct TimeSyncHelperErrorCodeCategory : std::error_category {
2525
};
2626

2727
bool TimeSyncHelperErrorCodeCategory::equivalent(int valcode,
28-
const std::error_condition& cond) const noexcept {
28+
const std::error_condition& cond) const noexcept {
2929
if (cond == SuccessCondition::Success) return (valcode == 0);
3030
if (cond == ErrorTypeCondition::SDKError) return true;
3131
return false;
3232
}
3333

34-
const char* TimeSyncHelperErrorCodeCategory::name() const noexcept { return "TimeSyncHelperErrorCode"; }
34+
const char* TimeSyncHelperErrorCodeCategory::name() const noexcept {
35+
return "TimeSyncHelperErrorCode";
36+
}
3537

3638
std::string TimeSyncHelperErrorCodeCategory::message(int value) const {
3739
switch (static_cast<TimeSyncHelperErrorCode>(value)) {
@@ -43,21 +45,22 @@ std::string TimeSyncHelperErrorCodeCategory::message(int value) const {
4345

4446
const TimeSyncHelperErrorCodeCategory TimeSyncHelperErrorCodeCategory_category{};
4547

46-
4748
struct EstablishTimeSyncErrorCodeCategory : std::error_category {
4849
const char* name() const noexcept override;
4950
std::string message(int ev) const override;
5051
bool equivalent(int valcode, const std::error_condition& cond) const noexcept override;
5152
};
5253

53-
bool EstablishTimeSyncErrorCodeCategory::equivalent(int valcode,
54-
const std::error_condition& cond) const noexcept {
54+
bool EstablishTimeSyncErrorCodeCategory::equivalent(
55+
int valcode, const std::error_condition& cond) const noexcept {
5556
if (cond == SuccessCondition::Success) return (valcode == 0);
5657
if (cond == ErrorTypeCondition::SDKError) return true;
5758
return false;
5859
}
5960

60-
const char* EstablishTimeSyncErrorCodeCategory::name() const noexcept { return "EstablishTimeSyncErrorCode"; }
61+
const char* EstablishTimeSyncErrorCodeCategory::name() const noexcept {
62+
return "EstablishTimeSyncErrorCode";
63+
}
6164

6265
std::string EstablishTimeSyncErrorCodeCategory::message(int value) const {
6366
switch (static_cast<EstablishTimeSyncErrorCode>(value)) {
@@ -76,13 +79,15 @@ struct RobotTimeSyncErrorCodeCategory : std::error_category {
7679
};
7780

7881
bool RobotTimeSyncErrorCodeCategory::equivalent(int valcode,
79-
const std::error_condition& cond) const noexcept {
82+
const std::error_condition& cond) const noexcept {
8083
if (cond == SuccessCondition::Success) return (valcode == 0);
8184
if (cond == ErrorTypeCondition::SDKError) return true;
8285
return false;
8386
}
8487

85-
const char* RobotTimeSyncErrorCodeCategory::name() const noexcept { return "RobotTimeSyncErrorCode"; }
88+
const char* RobotTimeSyncErrorCodeCategory::name() const noexcept {
89+
return "RobotTimeSyncErrorCode";
90+
}
8691

8792
std::string RobotTimeSyncErrorCodeCategory::message(int value) const {
8893
switch (static_cast<RobotTimeSyncErrorCode>(value)) {
@@ -94,7 +99,7 @@ std::string RobotTimeSyncErrorCodeCategory::message(int value) const {
9499

95100
const RobotTimeSyncErrorCodeCategory RobotTimeSyncErrorCodeCategory_category{};
96101

97-
} // anonymous namespace
102+
} // anonymous namespace
98103

99104
std::error_code make_error_code(RobotTimeSyncErrorCode value) {
100105
return {static_cast<int>(value), RobotTimeSyncErrorCodeCategory_category};

cpp/bosdyn/client/error_codes/time_sync_helper_error_code.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ std::error_code make_error_code(TimeSyncHelperErrorCode);
3131
std::error_code make_error_code(EstablishTimeSyncErrorCode);
3232
std::error_code make_error_code(RobotTimeSyncErrorCode);
3333

34-
} // client namespace
35-
} // bosdyn namespace
34+
} // namespace client
35+
} // namespace bosdyn
3636

3737
namespace std {
3838
template <>

cpp/bosdyn/client/estop/estop_keepalive.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@
1818

1919
#include <bosdyn/api/estop.pb.h>
2020

21-
#include "bosdyn/common/status.h"
2221
#include "bosdyn/client/estop/estop_client.h"
2322
#include "bosdyn/client/estop/estop_endpoint.h"
23+
#include "bosdyn/common/status.h"
2424

2525
namespace bosdyn {
2626

cpp/bosdyn/client/processors/common_response_processor.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88

99

1010
#include "common_response_processor.h"
11-
#include "bosdyn/client/error_codes/sdk_error_code.h"
1211
#include "bosdyn/client/error_codes/header_error_code.h"
12+
#include "bosdyn/client/error_codes/sdk_error_code.h"
1313

1414
namespace bosdyn {
1515

0 commit comments

Comments
 (0)