Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update DEVELOPMENT.md #455

Merged
merged 3 commits into from
Dec 17, 2024
Merged

docs: update DEVELOPMENT.md #455

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cb320e6
update DEVELOPMENT.md
airkei Dec 16, 2024
8f9e639
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 16, 2024
fdd7ac8
remove ECU installation section
airkei Dec 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 1 addition & 47 deletions DEVELOPMENT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,52 +14,6 @@ $ python3 --version
Python 3.8.10
```

## How to run OTA client on the target ECU

Appropriate partitioning and configurations are required. See [docs/README.md](docs/README.md).

Installation guide is available at [docs/INSTALLATION.md](docs/INSTALLATION.md).

### Run otaclient directly

```bash
# with virtualenv activated
python3 -m otaclient
# or
python3 -m otaclient.app
```

### Run otaclient installed at custom location

If we install the otaclient to custom directory instead of the default location, we must indicate python the path to the install location.

#### method 1: indicate path by **PYTHONPATH**

```bash
# we have to append the /opt/ota to the PYTHONPATH, to tell the
# python interpreter to search otaclient package under /opt/ota, instead of
# using the one install under <virtualenv>/lib/python3.8/site-packages

# with venv activated:
PYTHONPATH=/opt/ota python3 -m otaclient
# or
PYTHONPATH=/opt/ota python3 -m otaclient.app
```

#### method 2: change working dir to the install location

```bash
# change work dir to /opt/ota
cd /opt/ota

# with venv activated:
# NOTE:python will insert current working dir at index 0 in `sys.path`
# under /opt/ota folder, so that python will first use otaclient under /opt/ota
python3 -m otaclient
# or
python3 -m otaclient.app
```

## How to test OTA client on the development PC

### Build the image for testing
Expand Down Expand Up @@ -158,7 +112,7 @@ Type "help", "copyright", "credits" or "license" for more information.
>>> from otaclient_pb2.v2 import otaclient_pb2_grpc
```

### Updating docs/SERVICES.md
### Creating docs/SERVICES.md

The protobuf document docs/SERVICES.md should be updated by protoc-gen-doc tool.

Expand Down
Loading