Skip to content

Commit

Permalink
fix(autoware_node): fix spell-check errors
Browse files Browse the repository at this point in the history
Signed-off-by: Alexey Panferov <[email protected]>
  • Loading branch information
lexavtanke committed Mar 14, 2024
1 parent ecf6e7c commit 1745e06
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions common/autoware_node/README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
# Autoware Node

## Overview

<!-- cspell:ignore registrate -->
Autoware Node is an Autoware.Core package designed to provide a base class for all future nodes in the system. It provides ability to registrate node to _Autoware_control_center_ (ACC), report node state, publish heartbeat and subscribe to monitored topics. It also inheritates all lifecycle control capabilities of the base class [LifecycleNode](https://docs.ros2.org/latest/api/rclcpp_lifecycle/classrclcpp__lifecycle_1_1LifecycleNode.html)

## Usage

You can use _autoware_node_ as a base class for any node in Autoware.Core system. There is an example package _test_node_ which shows how _autoware_node_ commuticate with ACC and other _autoware_nodes_. You can check it for more information.
You can use _autoware_node_ as a base class for any node in Autoware.Core system. There is an example package _test_node_ which shows how _autoware_node_ communicate with ACC and other _autoware_nodes_. You can check it for more information.

## Design

_Autoware_node_ inheritates from  ROS2 [_lifecycle_node_](https://design.ros2.org/articles/node_lifecycle.html) and has all basic fuctions of it.
<!-- cspell:ignore  ROS2 -->
_Autoware_node_ inherits from  ROS2 [_lifecycle_node_](https://design.ros2.org/articles/node_lifecycle.html) and has all basic functions of it.

Below are the main add-ons and how they work.

### Registration

After startup each _autoware_node_ tries to register itself to ACC via a service call of _AutowareNodeRegister_. It happens in the dedicated timer. The timer will stop after the successful registration.

### De-registraion
### De-registration

If _autoware_node_ receives a request to it's _AutowareControlCenterDeregister_ service. It will disable the flag _registered_ and it will startup timer which control registration client.

Expand Down

0 comments on commit 1745e06

Please sign in to comment.