Skip to content
33 changes: 33 additions & 0 deletions proto/ignition/msgs/parameter.proto
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
/*
* Copyright (C) 2022 Open Source Robotics Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/

syntax = "proto3";

import "google/protobuf/any.proto";

package ignition.msgs;
option java_package = "com.ignition.msgs";

/// \brief Representation of a parameter, used to request to set a parameter.
message Parameter
{
/// \brief Parameter name.
string name = 1;

/// \brief Serialized parameter value.
google.protobuf.Any value = 2;
};
33 changes: 33 additions & 0 deletions proto/ignition/msgs/parameter_declaration.proto
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
/*
* Copyright (C) 2022 Open Source Robotics Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/

syntax = "proto3";

package ignition.msgs;
option java_package = "com.ignition.msgs";

import "ignition/msgs/parameter.proto";

/// \brief Representation of a parameter declaration.
message ParameterDeclaration
{
/// \brief Parameter name.
string name = 1;

/// \brief Parameter type, i.e. the associated protobuf type.
string type = 2;
};
30 changes: 30 additions & 0 deletions proto/ignition/msgs/parameter_declarations.proto
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
/*
* Copyright (C) 2022 Open Source Robotics Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/

syntax = "proto3";

package ignition.msgs;
option java_package = "com.ignition.msgs";

import "ignition/msgs/parameter_declaration.proto";

/// \brief Collection of parameter declarations.
message ParameterDeclarations
{
/// \brief Parameter declarations.
repeated ParameterDeclaration parameter_declarations = 1;
};
33 changes: 33 additions & 0 deletions proto/ignition/msgs/parameter_error.proto
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
/*
* Copyright (C) 2022 Open Source Robotics Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/

syntax = "proto3";

package ignition.msgs;
option java_package = "com.ignition.msgs";

/// \brief Parameter server errors for declare or set parameter.
message ParameterError
{
enum Type {
NO_ERROR = 0;
ALREADY_DECLARED = 1;
INVALID_TYPE = 2;
NOT_DECLARED = 3;
}
Type data = 1;
};
28 changes: 28 additions & 0 deletions proto/ignition/msgs/parameter_name.proto
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
/*
* Copyright (C) 2022 Open Source Robotics Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/

syntax = "proto3";

package ignition.msgs;
option java_package = "com.ignition.msgs";

/// \brief Parameter name, used as a request to get a parameter.
message ParameterName
{
/// \brief Parameter name.
string name = 1;
};
30 changes: 30 additions & 0 deletions proto/ignition/msgs/parameter_value.proto
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
/*
* Copyright (C) 2022 Open Source Robotics Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/

syntax = "proto3";

import "google/protobuf/any.proto";

package ignition.msgs;
option java_package = "com.ignition.msgs";

/// \brief Representation of a parameter value, used as a response to get a parameter.
message ParameterValue
{
/// \brief Serialized protobuf message.
google.protobuf.Any data = 1;
};