Skip to content

Commit

Permalink
[Meta]: Update project name, URL, and sonar organization name
Browse files Browse the repository at this point in the history
Updated most references to Isobus++ to be AgIsoStack++
  • Loading branch information
ad3154 committed May 29, 2023
1 parent 9266b60 commit 39328bf
Show file tree
Hide file tree
Showing 23 changed files with 63 additions and 62 deletions.
5 changes: 3 additions & 2 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,8 @@ install(FILES "${CMAKE_CURRENT_BINARY_DIR}/isobusConfig.cmake"

set(CPACK_PACKAGE_CONTACT "[email protected]")
set(CPACK_DEBIAN_FILENAME DEB-DEFAULT)
set(CPACK_DEBIAN_PACKAGE_HOMEPAGE "https://github.com/ad3154/Isobus-plus-plus")
set(CPACK_PACKAGE_VENDOR "https://github.com/ad3154/Isobus-plus-plus")
set(CPACK_DEBIAN_PACKAGE_HOMEPAGE
"https://github.com/Open-Agriculture/AgIsoStack-plus-plus")
set(CPACK_PACKAGE_VENDOR "Open-Agriculture")
set(CPACK_COMPONENTS_GROUPING ALL_COMPONENTS_IN_ONE)
include(CPack)
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing to ISOBUS++
# Contributing to AgIsoStack++

We warmly welcome you to Isobus++! Contributing to our open source repository implementing the ISOBUS (ISO11783) standard in the agricultural industry can involve anything from adding new features, improving existing code, fixing bugs, or even just helping to test and document the project. We greatly appreciate any contributions you can make to help drive progress and innovation in this field. Thank you for your interest and support!
We warmly welcome you to AgIsoStack++! Contributing to our open source repository implementing the ISOBUS (ISO11783) standard in the agricultural industry can involve anything from adding new features, improving existing code, fixing bugs, or even just helping to test and document the project. We greatly appreciate any contributions you can make to help drive progress and innovation in this field. Thank you for your interest and support!

We accept all public contributions that adhere to our code of conduct. Additionally, for PR's we require the pass of all automated pre-merge checks, and a manual code review by a repository maintainer to ensure that our high code quality and project standards are maintained.

Expand Down Expand Up @@ -60,7 +60,7 @@ VS Code can be installed via the snap store, or by downloading it from [Microsof
Clone the repo:

```
git clone https://github.com/ad3154/Isobus-plus-plus.git
git clone https://github.com/Open-Agriculture/AgIsoStack-plus-plus.git
```

Then, open it in Code by clicking `File -> Open Folder`.
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
![ISOBUS++Logo](docs/images/wideLogoTransparent.png)
![AgIsoStack++Logo](docs/images/wideLogoTransparent.png)

![Features](docs/images/features.png)

![TaskController](docs/images/taskController.png)

## About This Library

Isobus++ is an MIT licensed hardware agnostic ISOBUS (ISO11783) and SAE J1939 CAN stack written in C++.
AgIsoStack++ (Formerly Isobus++) is an MIT licensed hardware agnostic ISOBUS (ISO11783) and SAE J1939 CAN stack written in C++.

The library transparently supports the entire ISOBUS/J1939 transport layer, automatic address claiming, and many of the high level ISOBUS protocols, such as:

Expand Down Expand Up @@ -38,7 +38,7 @@ A default CAN driver plug-in will be selected for you based on your OS, but when

Or specify multiple using a semicolon separated list: `-DCAN_DRIVER="<driver1>;<driver2>"`

If your target hardware is not listed above, you can easily integrate your own hardware by [implementing a few simple functions](https://github.com/ad3154/ISO11783-CAN-Stack/tree/main/hardware_integration#writing-a-new-can-driver-for-the-stack).
If your target hardware is not listed above, you can easily integrate your own hardware by [implementing a few simple functions](https://github.com/Open-Agriculture/AgIsoStack-plus-plus/tree/main/hardware_integration#writing-a-new-can-driver-for-the-stack).

## Examples

Expand Down
Binary file modified docs/images/wideLogoTransparent.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8
# title of most generated pages and in a few other places.
# The default value is: My Project.

PROJECT_NAME = Isobus++
PROJECT_NAME = AgIsoStack++

# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
# could be handy for archiving the generated documentation or if some version
Expand Down
4 changes: 2 additions & 2 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ Then, use a call to `find_package()` to find this package.

The same process can be used for all examples, however `diagnostic_protocol` is just shown as a reference.

First, build the Isobus-plus-plus CAN Stack.
First, build AgIsoStack-plus-plus.
```
# Build the library like normal
cd /path/to/root/directory/of/Isobus-plus-plus
cd /path/to/root/directory/of/AgIsoStack-plus-plus
cmake -S . -B build
cmake --build build
# Install it locally in a directory called "install"
Expand Down
4 changes: 2 additions & 2 deletions examples/diagnostic_protocol/main.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,8 @@ int main()
{
// Set a product identification string (in case someone requests it)
diagnosticProtocol->set_product_identification_code("1234567890ABC");
diagnosticProtocol->set_product_identification_brand("Del Grosso Engineering");
diagnosticProtocol->set_product_identification_model("Isobus++ CAN Stack DP Example");
diagnosticProtocol->set_product_identification_brand("Open-Agriculture");
diagnosticProtocol->set_product_identification_model("AgIsoStack++ CAN Stack DP Example");

// Set a software ID string (This is what tells other ECUs what version your software is)
diagnosticProtocol->set_software_id_field(0, "Diagnostic Protocol Example 1.0.0");
Expand Down
2 changes: 1 addition & 1 deletion examples/pgn_requests/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ For this example to work properly, you must have a valid, functional ISO 11783 C

## The Basics

This example will assume you have already learned the basics of the stack and ISOBUS communication, and won't go over the basic setup of your internal control function. If you need to brush up on those topics, check out the [transport layer example](https://github.com/ad3154/Isobus-plus-plus/tree/main/examples/transport_layer) first, or visit our [tutorial website](https://isobus-plus-plus.readthedocs.io/en/latest/index.html).
This example will assume you have already learned the basics of the stack and ISOBUS communication, and won't go over the basic setup of your internal control function. If you need to brush up on those topics, check out the [transport layer example](https://github.com/Open-Agriculture/AgIsoStack-plus-plus/tree/main/examples/transport_layer) first, or visit our [tutorial website](https://isobus-plus-plus.readthedocs.io/en/latest/index.html).

## PGN Requests

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ bool SectionControlImplementSimulator::create_ddop(std::shared_ptr<isobus::Devic

// Make a test pool as a 120ft sprayer with 16 sections, 1 liquid product
// Set up device
retVal &= poolToPopulate->add_device("Isobus++ UnitTest", "1.0.0", "123", "I++1.0", localizationData, std::vector<std::uint8_t>(), clientName.get_full_name());
retVal &= poolToPopulate->add_device("AgIsoStack++ UnitTest", "1.0.0", "123", "A++1.0", localizationData, std::vector<std::uint8_t>(), clientName.get_full_name());
retVal &= poolToPopulate->add_device_element("Sprayer", elementCounter++, 0, isobus::task_controller_object::DeviceElementObject::Type::Device, static_cast<std::uint16_t>(ImplementDDOPObjectIDs::MainDeviceElement));
retVal &= poolToPopulate->add_device_process_data("Actual Work State", static_cast<std::uint16_t>(isobus::DataDescriptionIndex::ActualWorkState), isobus::task_controller_object::Object::NULL_OBJECT_ID, static_cast<std::uint8_t>(isobus::task_controller_object::DeviceProcessDataObject::PropertiesBit::MemberOfDefaultSet), static_cast<std::uint8_t>(isobus::task_controller_object::DeviceProcessDataObject::AvailableTriggerMethods::OnChange), static_cast<std::uint16_t>(ImplementDDOPObjectIDs::DeviceActualWorkState));
retVal &= poolToPopulate->add_device_process_data("Request Default PD", static_cast<std::uint16_t>(ImplementDDOPObjectIDs::RequestDefaultProcessData), isobus::task_controller_object::Object::NULL_OBJECT_ID, 0, static_cast<std::uint8_t>(isobus::task_controller_object::DeviceProcessDataObject::AvailableTriggerMethods::Total), static_cast<std::uint16_t>(ImplementDDOPObjectIDs::RequestDefaultProcessData));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -544,7 +544,7 @@ namespace isobus
/// @brief Enumerates the modes that the client may use when dealing with a DDOP
enum class DDOPUploadType
{
ProgramaticallyGenerated, ///< Using the isobus++ DeviceDescriptorObjectPool class
ProgramaticallyGenerated, ///< Using the AgIsoStack++ DeviceDescriptorObjectPool class
UserProvidedBinaryPointer, ///< Using a raw pointer to a binary DDOP
UserProvidedVector ///< Uses a vector of bytes that comprise a binary DDOP
};
Expand Down
4 changes: 2 additions & 2 deletions library.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{
"name": "Isobus++",
"name": "AgIsoStack++",
"version": "1.0.0",
"description": "The Free ISO11783 & J1939 CAN Stack",
"keywords": "can, isobus, j1939, agritech, smart-farming, iso11783",
"repository": {
"type": "git",
"url": "https://github.com/ad3154/Isobus-plus-plus.git"
"url": "https://github.com/Open-Agriculture/AgIsoStack-plus-plus.git"
},
"license": "MIT",
"homepage": "https://isobusplusplus.com/",
Expand Down
2 changes: 1 addition & 1 deletion sonar-project.properties
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
sonar.projectKey=ad3154_ISO11783-CAN-Stack
sonar.organization=isobus-plusplus
sonar.organization=open-agriculture

# This is the name and version displayed in the SonarCloud UI.
#sonar.projectVersion=1.0.0
Expand Down
4 changes: 2 additions & 2 deletions sphinx/source/API Documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ Compiling the Doxygen locally

You can also generate the Doxygen yourself and browse it locally.

From your project, change directory into the 'Isobus-plus-plus' folder.
From your project, change directory into the 'AgIsoStack-plus-plus' folder.

.. code-block:: bash
cd Isobus-plus-plus
cd AgIsoStack-plus-plus
Make sure you have Doxygen installed.

Expand Down
4 changes: 2 additions & 2 deletions sphinx/source/Concepts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ Here are the different transport layers this library provides, along with a shor
* ISO11783 Adopts this protocol for a subset of standard GNSS messages
* This protocol provides a means to stream up to 223 bytes of data, with the advantage that each frame retains the parameter group number and priority, where TP and ETP do not.

In general, the ISOBUS++ library will take care of choosing which protocol to use automatically.
In general, the AgIsoStack++ library will take care of choosing which protocol to use automatically.

Now that you understand these concepts, if you've done the other :doc:`tutorials <Tutorials>`, check out the :doc:`Transport Layer Tutorial <Tutorials/Transport Layer>` and `example <https://github.com/ad3154/Isobus-plus-plus/tree/main/examples/transport_layer>`_.
Now that you understand these concepts, if you've done the other :doc:`tutorials <Tutorials>`, check out the :doc:`Transport Layer Tutorial <Tutorials/Transport Layer>` and `example <https://github.com/Open-Agriculture/AgIsoStack-plus-plus/tree/main/examples/transport_layer>`_.

4 changes: 2 additions & 2 deletions sphinx/source/FAQ.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ If you are seeing something similar to this error:

.. code-block:: text
/usr/bin/ld: Isobus-plus-plus/socket_can/libSocketCANInterface.so: undefined reference to `pthread_create'
/usr/bin/ld: AgIsoStack-plus-plus/socket_can/libSocketCANInterface.so: undefined reference to `pthread_create'
collect2: error: ld returned 1 exit status
make[2]: *** [CMakeFiles/isobus_hello_world.dir/build.make:86: isobus_hello_world] Error 1
make[1]: *** [CMakeFiles/Makefile2:285: CMakeFiles/isobus_hello_world.dir/all] Error 2
Expand All @@ -43,4 +43,4 @@ I have some other issue!
-------------------------

Please submit an issue at the project's GitHub page:
https://github.com/ad3154/Isobus-plus-plus/issues
https://github.com/Open-Agriculture/AgIsoStack-plus-plus/issues
20 changes: 10 additions & 10 deletions sphinx/source/Installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Installation
Supported Platforms
--------------------

We officially support building ISOBUS++ from source on the following platforms:
We officially support building AgIsoStack++ from source on the following platforms:
* Ubuntu Linux (Non-WSL)
* Raspberry Pi OS (Raspbian)
* RHEL
Expand All @@ -20,7 +20,7 @@ We officially support building ISOBUS++ from source on the following platforms:

.. note::

ISOBUS++ may also work on other platforms, and has been designed to accommodate different underlying hardware, but the ones listed above are the officially supported platforms. Additional platform support may be added if there is demand for it.
AgIsoStack++ may also work on other platforms, and has been designed to accommodate different underlying hardware, but the ones listed above are the officially supported platforms. Additional platform support may be added if there is demand for it.

Using a supported platform will get you the best support for any issues you may encounter.

Expand All @@ -37,17 +37,17 @@ First, lets prepare the dependencies we'll need to compile the CAN stack. These
sudo apt install build-essential cmake git
Downloading ISOBUS++
----------------------
Downloading AgIsoStack++
-------------------------

In your project that you want to add the CAN stack to, add the CAN stack as a submodule.

.. code-block:: bash
git submodule add https://github.com/ad3154/Isobus-plus-plus.git
git submodule add https://github.com/Open-Agriculture/AgIsoStack-plus-plus.git
git submodule update --init --recursive
This will place the CAN stack in a folder within your project called 'Isobus-plus-plus'.
This will place the CAN stack in a folder within your project called 'AgIsoStack-plus-plus'.

Building the CAN Stack
-----------------------
Expand All @@ -57,14 +57,14 @@ There are a couple options for the next step.
CMake:
^^^^^^

If your project is already using CMake to build your project, or this is a new project, the suggested way to get the library compiling is to add the 'Isobus-plus-plus' folder we just created to your CMake as a subdirectory.
If your project is already using CMake to build your project, or this is a new project, the suggested way to get the library compiling is to add the 'AgIsoStack-plus-plus' folder we just created to your CMake as a subdirectory.

.. code-block:: text
set(THREADS_PREFER_PTHREAD_FLAG ON)
find_package(Threads REQUIRED)
add_subdirectory("Isobus-plus-plus")
add_subdirectory("AgIsoStack-plus-plus")
...
Expand All @@ -75,6 +75,6 @@ Using CMake has a lot of advantages, such as if the library is updated with addi
Non-CMake:
^^^^^^^^^^

If you are not using CMake, just make sure to add all the files from the 'Isobus-plus-plus/isobus' folder, the 'Isobus-plus-plus/hardware_integration' folder, and the 'Isobus-plus-plus/utility' folder to your project so they all get compiled.
If you are not using CMake, just make sure to add all the files from the 'AgIsoStack-plus-plus/isobus' folder, the 'AgIsoStack-plus-plus/hardware_integration' folder, and the 'AgIsoStack-plus-plus/utility' folder to your project so they all get compiled.

You'll want to make sure the 'Isobus-plus-plus/isobus/include/isobus/isobus' folder is part of your include path as well as 'Isobus-plus-plus/utility/include/isobus/utility' and 'Isobus-plus-plus/hardware_integration/include/isobus/hardware_integration'.
You'll want to make sure the 'AgIsoStack-plus-plus/isobus/include/isobus/isobus' folder is part of your include path as well as 'AgIsoStack-plus-plus/utility/include/isobus/utility' and 'AgIsoStack-plus-plus/hardware_integration/include/isobus/hardware_integration'.
2 changes: 1 addition & 1 deletion sphinx/source/Tutorials/Debug Logging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,4 @@ The logger must be static or otherwise not go out of scope, as the CAN stack sav

That's all there is to it! Now, when you run your program you should see some logging messages are written to your console.

A full example of this is included with the `VT example program <https://github.com/ad3154/Isobus-plus-plus/blob/main/examples/virtual_terminal/version3_object_pool/main.cpp>`_.
A full example of this is included with the `VT example program <https://github.com/Open-Agriculture/AgIsoStack-plus-plus/blob/main/examples/virtual_terminal/version3_object_pool/main.cpp>`_.
8 changes: 4 additions & 4 deletions sphinx/source/Tutorials/The ISOBUS Hello World.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Let's set up a standard, empty C++ program in a file called "main.cpp", and incl

The file `"can_network_manager.hpp" <https://delgrossoengineering.com/isobus-docs/can__network__manager_8hpp.html>`_ is the header file for the main interface for the CAN stack.

The file `"socket_can_interface.hpp" <https://github.com/ad3154/Isobus-plus-plus/blob/main/socket_can/include/socket_can_interface.hpp>`_ is a hardware tie-in for socket CAN.
The file `"socket_can_interface.hpp" <https://github.com/Open-Agriculture/AgIsoStack-plus-plus/blob/main/socket_can/include/socket_can_interface.hpp>`_ is a hardware tie-in for socket CAN.

The file `"can_partnered_control_function.hpp" <https://delgrossoengineering.com/isobus-docs/can__partnered__control__function_8hpp.html>`_ Defines the interface for a *partnered control function*, which is another device you want to communicate with.

Expand Down Expand Up @@ -412,12 +412,12 @@ This will send our 8 byte message of all zeros to the global address, using the
Compiling The Program (Using CMake)
------------------------------------

Assuming you followed the :doc:`installation instructions <../Installation>` the program we just wrote should be in a folder, and the library should be in a directory called Isobus-plus-plus, like this:
Assuming you followed the :doc:`installation instructions <../Installation>` the program we just wrote should be in a folder, and the library should be in a directory called AgIsoStack-plus-plus, like this:

.. code-block:: bash
ls
Isobus-plus-plus main.cpp
AgIsoStack-plus-plus main.cpp
To get everything compiling into a program using CMake, let's add a CMakeLists.txt file.

Expand All @@ -437,7 +437,7 @@ Add the following to a new file called CMakeLists.txt:
set(THREADS_PREFER_PTHREAD_FLAG ON)
find_package(Threads REQUIRED)
add_subdirectory("Isobus-plus-plus")
add_subdirectory("AgIsoStack-plus-plus")
add_executable(isobus_hello_world main.cpp)
Expand Down
2 changes: 1 addition & 1 deletion sphinx/source/Tutorials/Transport Layer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,6 @@ You can do this by calling :code:`isobus::FastPacketProtocol::Protocol.register_

.. note::

A full example of both sending and receiving can be found in the `examples folder <https://github.com/ad3154/Isobus-plus-plus/tree/main/examples>`_ of this project.
A full example of both sending and receiving can be found in the `examples folder <https://github.com/Open-Agriculture/AgIsoStack-plus-plus/tree/main/examples>`_ of this project.

That's it for this tutorial! Sending 100MB CAN messages has never been easier.
Loading

0 comments on commit 39328bf

Please sign in to comment.