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

[Meta/Examples]: Update all example manufacturer codes to 1407 (Open-Agriculture) #348

Merged
merged 1 commit into from
Nov 10, 2023
Merged

[Meta/Examples]: Update all example manufacturer codes to 1407 (Open-Agriculture) #348

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,14 @@ sudo cmake --install build

Then, use a call to `find_package()` to find this package.

### Use of our SAE/ISOBUS Manufacturer Code

If you are integrating with our library to create an ISO11783 or J1939 application and are not selling your software or device containing that software for-profit, then you are welcome to use our manufacturer number in your application.

If you are creating such an application for sale as a for-profit company, then we ask that you please obtain your own manufacturer code from SAE instead of using ours.

Our manufacturer code is 1407 (decimal).

## Documentation

You can view the pre-compiled doxygen here https://delgrossoengineering.com/isobus-docs
Expand Down
3 changes: 1 addition & 2 deletions examples/diagnostic_protocol/main.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,6 @@ int main()
isobus::NAME TestDeviceNAME(0);

//! Make sure you change these for your device!!!!
//! This is an example device that is using a manufacturer code that is currently unused at time of writing
TestDeviceNAME.set_arbitrary_address_capable(true);
TestDeviceNAME.set_industry_group(0);
TestDeviceNAME.set_device_class(0);
Expand All @@ -63,7 +62,7 @@ int main()
TestDeviceNAME.set_ecu_instance(0);
TestDeviceNAME.set_function_instance(0);
TestDeviceNAME.set_device_class_instance(0);
TestDeviceNAME.set_manufacturer_code(64);
TestDeviceNAME.set_manufacturer_code(1407);

auto TestInternalECU = isobus::InternalControlFunction::create(TestDeviceNAME, 0x1C, 0);

Expand Down
3 changes: 1 addition & 2 deletions examples/guidance/main.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,6 @@ int main()
isobus::NAME TestDeviceNAME(0);

//! Make sure you change these for your device!!!!
//! This is an example device that is using a manufacturer code that is currently unused at time of writing
TestDeviceNAME.set_arbitrary_address_capable(true);
TestDeviceNAME.set_industry_group(1);
TestDeviceNAME.set_device_class(0);
Expand All @@ -100,7 +99,7 @@ int main()
TestDeviceNAME.set_ecu_instance(0);
TestDeviceNAME.set_function_instance(0);
TestDeviceNAME.set_device_class_instance(0);
TestDeviceNAME.set_manufacturer_code(64);
TestDeviceNAME.set_manufacturer_code(1407);

isobus::AgriculturalGuidanceInterface TestGuidanceInterface(nullptr, nullptr);

Expand Down
3 changes: 1 addition & 2 deletions examples/nmea2000/fast_packet_protocol/main.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,6 @@ int main()
isobus::NAME TestDeviceNAME(0);

//! Make sure you change these for your device!!!!
//! This is an example device that is using a manufacturer code that is currently unused at time of writing
TestDeviceNAME.set_arbitrary_address_capable(true);
TestDeviceNAME.set_industry_group(0);
TestDeviceNAME.set_device_class(0);
Expand All @@ -83,7 +82,7 @@ int main()
TestDeviceNAME.set_ecu_instance(0);
TestDeviceNAME.set_function_instance(0);
TestDeviceNAME.set_device_class_instance(0);
TestDeviceNAME.set_manufacturer_code(64);
TestDeviceNAME.set_manufacturer_code(1407);

auto TestInternalECU = isobus::InternalControlFunction::create(TestDeviceNAME, 0x1C, 0);

Expand Down
3 changes: 1 addition & 2 deletions examples/nmea2000/nmea2000_generator/main.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,6 @@ int main()
isobus::NAME TestDeviceNAME(0);

//! Make sure you change these for your device!!!!
//! This is an example device that is using a manufacturer code that is currently unused at time of writing
TestDeviceNAME.set_arbitrary_address_capable(true);
TestDeviceNAME.set_industry_group(0);
TestDeviceNAME.set_device_class(0);
Expand All @@ -61,7 +60,7 @@ int main()
TestDeviceNAME.set_ecu_instance(0);
TestDeviceNAME.set_function_instance(0);
TestDeviceNAME.set_device_class_instance(0);
TestDeviceNAME.set_manufacturer_code(64);
TestDeviceNAME.set_manufacturer_code(1407);

auto TestInternalECU = isobus::InternalControlFunction::create(TestDeviceNAME, 0x1C, 0);

Expand Down
3 changes: 1 addition & 2 deletions examples/nmea2000/nmea2000_parser/main.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,6 @@ int main()
isobus::NAME TestDeviceNAME(0);

//! Make sure you change these for your device!!!!
//! This is an example device that is using a manufacturer code that is currently unused at time of writing
TestDeviceNAME.set_arbitrary_address_capable(true);
TestDeviceNAME.set_industry_group(0);
TestDeviceNAME.set_device_class(0);
Expand All @@ -136,7 +135,7 @@ int main()
TestDeviceNAME.set_ecu_instance(0);
TestDeviceNAME.set_function_instance(0);
TestDeviceNAME.set_device_class_instance(0);
TestDeviceNAME.set_manufacturer_code(64);
TestDeviceNAME.set_manufacturer_code(1407);

auto TestInternalECU = isobus::InternalControlFunction::create(TestDeviceNAME, 0x1D, 0);

Expand Down
3 changes: 1 addition & 2 deletions examples/pgn_requests/main.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,6 @@ int main()
isobus::NAME TestDeviceNAME(0);

//! Make sure you change these for your device!!!!
//! This is an example device that is using a manufacturer code that is currently unused at time of writing
TestDeviceNAME.set_arbitrary_address_capable(true);
TestDeviceNAME.set_industry_group(1);
TestDeviceNAME.set_device_class(0);
Expand All @@ -124,7 +123,7 @@ int main()
TestDeviceNAME.set_ecu_instance(0);
TestDeviceNAME.set_function_instance(0);
TestDeviceNAME.set_device_class_instance(0);
TestDeviceNAME.set_manufacturer_code(64);
TestDeviceNAME.set_manufacturer_code(1407);

auto TestInternalECU = isobus::InternalControlFunction::create(TestDeviceNAME, 0x1C, 0);
std::signal(SIGINT, signal_handler);
Expand Down
3 changes: 1 addition & 2 deletions examples/task_controller_client/main.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,6 @@ int main()
isobus::NAME TestDeviceNAME(0);

//! Make sure you change these for your device!!!!
//! This is an example device that is using a manufacturer code that is currently unused at time of writing
TestDeviceNAME.set_arbitrary_address_capable(true);
TestDeviceNAME.set_industry_group(2);
TestDeviceNAME.set_device_class(6);
Expand All @@ -72,7 +71,7 @@ int main()
TestDeviceNAME.set_ecu_instance(0);
TestDeviceNAME.set_function_instance(0);
TestDeviceNAME.set_device_class_instance(0);
TestDeviceNAME.set_manufacturer_code(64);
TestDeviceNAME.set_manufacturer_code(1407);

const isobus::NAMEFilter filterTaskController(isobus::NAME::NAMEParameters::FunctionCode, static_cast<std::uint8_t>(isobus::NAME::Function::TaskController));
const isobus::NAMEFilter filterTaskControllerInstance(isobus::NAME::NAMEParameters::FunctionInstance, 0);
Expand Down
3 changes: 1 addition & 2 deletions examples/transport_layer/main.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,6 @@ int main()
isobus::NAME TestDeviceNAME(0);

//! Make sure you change these for your device!!!!
//! This is an example device that is using a manufacturer code that is currently unused at time of writing
TestDeviceNAME.set_arbitrary_address_capable(true);
TestDeviceNAME.set_industry_group(1);
TestDeviceNAME.set_device_class(0);
Expand All @@ -66,7 +65,7 @@ int main()
TestDeviceNAME.set_ecu_instance(0);
TestDeviceNAME.set_function_instance(0);
TestDeviceNAME.set_device_class_instance(0);
TestDeviceNAME.set_manufacturer_code(64);
TestDeviceNAME.set_manufacturer_code(1407);

const isobus::NAMEFilter filterVirtualTerminal(isobus::NAME::NAMEParameters::FunctionCode, static_cast<std::uint8_t>(isobus::NAME::Function::VirtualTerminal));

Expand Down
3 changes: 1 addition & 2 deletions examples/virtual_terminal/aux_functions/main.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,6 @@ int main()
isobus::NAME TestDeviceNAME(0);

//! Make sure you change these for your device!!!!
//! This is an example device that is using a manufacturer code that is currently unused at time of writing
TestDeviceNAME.set_arbitrary_address_capable(true);
TestDeviceNAME.set_industry_group(1);
TestDeviceNAME.set_device_class(0);
Expand All @@ -76,7 +75,7 @@ int main()
TestDeviceNAME.set_ecu_instance(0);
TestDeviceNAME.set_function_instance(1);
TestDeviceNAME.set_device_class_instance(0);
TestDeviceNAME.set_manufacturer_code(64);
TestDeviceNAME.set_manufacturer_code(1407);

std::vector<std::uint8_t> testPool = isobus::IOPFileInterface::read_iop_file("aux_functions_pooldata.iop");

Expand Down
3 changes: 1 addition & 2 deletions examples/virtual_terminal/aux_inputs/main.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,6 @@ int main()
isobus::NAME TestDeviceNAME(0);

//! Make sure you change these for your device!!!!
//! This is an example device that is using a manufacturer code that is currently unused at time of writing
TestDeviceNAME.set_arbitrary_address_capable(true);
TestDeviceNAME.set_industry_group(1);
TestDeviceNAME.set_device_class(0);
Expand All @@ -139,7 +138,7 @@ int main()
TestDeviceNAME.set_ecu_instance(1);
TestDeviceNAME.set_function_instance(0);
TestDeviceNAME.set_device_class_instance(0);
TestDeviceNAME.set_manufacturer_code(64);
TestDeviceNAME.set_manufacturer_code(1407);

std::vector<std::uint8_t> testPool = isobus::IOPFileInterface::read_iop_file("aux_inputs_pooldata.iop");

Expand Down
3 changes: 1 addition & 2 deletions examples/virtual_terminal/esp32_platformio_object_pool/src/main.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,6 @@ extern "C" void app_main()
isobus::NAME TestDeviceNAME(0);

//! Make sure you change these for your device!!!!
//! This is an example device that is using a manufacturer code that is currently unused at time of writing
TestDeviceNAME.set_arbitrary_address_capable(true);
TestDeviceNAME.set_industry_group(1);
TestDeviceNAME.set_device_class(0);
Expand All @@ -99,7 +98,7 @@ extern "C" void app_main()
TestDeviceNAME.set_ecu_instance(0);
TestDeviceNAME.set_function_instance(0);
TestDeviceNAME.set_device_class_instance(0);
TestDeviceNAME.set_manufacturer_code(64);
TestDeviceNAME.set_manufacturer_code(1407);

const std::uint8_t *testPool = object_pool_start;

Expand Down
3 changes: 1 addition & 2 deletions examples/virtual_terminal/version3_object_pool/main.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,6 @@ int main()
isobus::NAME TestDeviceNAME(0);

//! Make sure you change these for your device!!!!
//! This is an example device that is using a manufacturer code that is currently unused at time of writing
TestDeviceNAME.set_arbitrary_address_capable(true);
TestDeviceNAME.set_industry_group(1);
TestDeviceNAME.set_device_class(0);
Expand All @@ -118,7 +117,7 @@ int main()
TestDeviceNAME.set_ecu_instance(0);
TestDeviceNAME.set_function_instance(0);
TestDeviceNAME.set_device_class_instance(0);
TestDeviceNAME.set_manufacturer_code(64);
TestDeviceNAME.set_manufacturer_code(1407);

std::vector<std::uint8_t> testPool = isobus::IOPFileInterface::read_iop_file("VT3TestPool.iop");

Expand Down
3 changes: 1 addition & 2 deletions sphinx/source/Tutorials/Adding a Destination.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,6 @@ The final program for this tutorial (including the code from the previous Hello
std::signal(SIGINT, signal_handler);

//! Make sure you change these for your device!!!!
//! This is an example device that is using a manufacturer code that is currently unused at time of writing
myNAME.set_arbitrary_address_capable(true);
myNAME.set_industry_group(1);
myNAME.set_device_class(0);
Expand All @@ -137,7 +136,7 @@ The final program for this tutorial (including the code from the previous Hello
myNAME.set_ecu_instance(0);
myNAME.set_function_instance(0);
myNAME.set_device_class_instance(0);
myNAME.set_manufacturer_code(64);
myNAME.set_manufacturer_code(1407);

// Define a NAME filter for our partner
std::vector<isobus::NAMEFilter> myPartnerFilter;
Expand Down
3 changes: 1 addition & 2 deletions sphinx/source/Tutorials/ESP32 PlatformIO.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,6 @@ This is boilerplate code that can be found in nearly every AgIsoStack project th
isobus::NAME TestDeviceNAME(0);

//! Make sure you change these for your device!!!!
//! This is an example device that is using a manufacturer code that is currently unused at time of writing
TestDeviceNAME.set_arbitrary_address_capable(true);
TestDeviceNAME.set_industry_group(1);
TestDeviceNAME.set_device_class(0);
Expand All @@ -207,7 +206,7 @@ This is boilerplate code that can be found in nearly every AgIsoStack project th
TestDeviceNAME.set_ecu_instance(0);
TestDeviceNAME.set_function_instance(0);
TestDeviceNAME.set_device_class_instance(0);
TestDeviceNAME.set_manufacturer_code(64);
TestDeviceNAME.set_manufacturer_code(1407);
auto TestInternalECU = isobus::InternalControlFunction::create(TestDeviceNAME, 0x81, 0);

while (true)
Expand Down
3 changes: 1 addition & 2 deletions sphinx/source/Tutorials/Receiving Messages.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,6 @@ So, our updated tutorial program now should look like this:
std::signal(SIGINT, signal_handler);

//! Make sure you change these for your device!!!!
//! This is an example device that is using a manufacturer code that is currently unused at time of writing
myNAME.set_arbitrary_address_capable(true);
myNAME.set_industry_group(1);
myNAME.set_device_class(0);
Expand All @@ -122,7 +121,7 @@ So, our updated tutorial program now should look like this:
myNAME.set_ecu_instance(0);
myNAME.set_function_instance(0);
myNAME.set_device_class_instance(0);
myNAME.set_manufacturer_code(64);
myNAME.set_manufacturer_code(1407);

// Create our InternalControlFunction
myECU = isobus::InternalControlFunction::create(myNAME, 0x1C, 0);
Expand Down
16 changes: 6 additions & 10 deletions sphinx/source/Tutorials/The ISOBUS Hello World.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,12 +92,12 @@ Now we have a NAME instantiated. We still need to populate it with our control f
myNAME.set_ecu_instance(0);
myNAME.set_function_instance(0);
myNAME.set_device_class_instance(0);
myNAME.set_manufacturer_code(64);
myNAME.set_manufacturer_code(1407);

return 0;
}

So now, we have a NAME with actual information encoded in it. In this example, we are an on-highway steering controller, our serial number is 2, we support address arbitration, and we claim to be manufactured by manufacturer 64, which is currently an unused code (but was formerly "SpectraPhysics").
So now, we have a NAME with actual information encoded in it. In this example, we are an on-highway steering controller, our serial number is 2, we support address arbitration, and we claim to be manufactured by manufacturer 1407 which is the Open-Agriculture manufacturer code.

Make sure to change these values to match your device's identity. Use `"isobus.net" <https://www.isobus.net/isobus/>`_ as a resource if you need to figure out all these values.\

Expand Down Expand Up @@ -127,7 +127,6 @@ In this example, I'll use a shared_ptr to store my InternalControlFunction, but
std::shared_ptr<isobus::InternalControlFunction> myECU = nullptr; // A pointer to hold our InternalControlFunction

//! Make sure you change these for your device!!!!
//! This is an example device that is using a manufacturer code that is currently unused at time of writing
myNAME.set_arbitrary_address_capable(true);
myNAME.set_industry_group(1);
myNAME.set_device_class(0);
Expand All @@ -136,7 +135,7 @@ In this example, I'll use a shared_ptr to store my InternalControlFunction, but
myNAME.set_ecu_instance(0);
myNAME.set_function_instance(0);
myNAME.set_device_class_instance(0);
myNAME.set_manufacturer_code(64);
myNAME.set_manufacturer_code(1407);

// Create our InternalControlFunction
myECU = isobus::InternalControlFunction::create(myNAME, 0x1C, 0);
Expand Down Expand Up @@ -228,7 +227,6 @@ Let's see what we've got so far:
}

//! Make sure you change these for your device!!!!
//! This is an example device that is using a manufacturer code that is currently unused at time of writing
myNAME.set_arbitrary_address_capable(true);
myNAME.set_industry_group(1);
myNAME.set_device_class(0);
Expand All @@ -237,7 +235,7 @@ Let's see what we've got so far:
myNAME.set_ecu_instance(0);
myNAME.set_function_instance(0);
myNAME.set_device_class_instance(0);
myNAME.set_manufacturer_code(64);
myNAME.set_manufacturer_code(1407);

// Create our InternalControlFunction
myECU = isobus::InternalControlFunction::create(myNAME, 0x1C, 0);
Expand Down Expand Up @@ -293,7 +291,6 @@ Make sure to include `csignal`.
std::signal(SIGINT, signal_handler);

//! Make sure you change these for your device!!!!
//! This is an example device that is using a manufacturer code that is currently unused at time of writing
myNAME.set_arbitrary_address_capable(true);
myNAME.set_industry_group(1);
myNAME.set_device_class(0);
Expand All @@ -302,7 +299,7 @@ Make sure to include `csignal`.
myNAME.set_ecu_instance(0);
myNAME.set_function_instance(0);
myNAME.set_device_class_instance(0);
myNAME.set_manufacturer_code(64);
myNAME.set_manufacturer_code(1407);

// Create our InternalControlFunction
myECU = isobus::InternalControlFunction::create(myNAME, 0x1C, 0);
Expand Down Expand Up @@ -361,7 +358,6 @@ The total result:
std::signal(SIGINT, signal_handler);

//! Make sure you change these for your device!!!!
//! This is an example device that is using a manufacturer code that is currently unused at time of writing
myNAME.set_arbitrary_address_capable(true);
myNAME.set_industry_group(1);
myNAME.set_device_class(0);
Expand All @@ -370,7 +366,7 @@ The total result:
myNAME.set_ecu_instance(0);
myNAME.set_function_instance(0);
myNAME.set_device_class_instance(0);
myNAME.set_manufacturer_code(64);
myNAME.set_manufacturer_code(1407);

// Create our InternalControlFunction
myECU = isobus::InternalControlFunction::create(myNAME, 0x1C, 0);
Expand Down
6 changes: 2 additions & 4 deletions sphinx/source/Tutorials/Virtual Terminal Basics.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,6 @@ Create the file `main.cpp` as shown below inside that folder with the requisite
isobus::NAME TestDeviceNAME(0);

//! Make sure you change these for your device!!!!
//! This is an example device that is using a manufacturer code that is currently unused at time of writing
TestDeviceNAME.set_arbitrary_address_capable(true);
TestDeviceNAME.set_industry_group(1);
TestDeviceNAME.set_device_class(0);
Expand All @@ -112,7 +111,7 @@ Create the file `main.cpp` as shown below inside that folder with the requisite
TestDeviceNAME.set_ecu_instance(0);
TestDeviceNAME.set_function_instance(0);
TestDeviceNAME.set_device_class_instance(0);
TestDeviceNAME.set_manufacturer_code(64);
TestDeviceNAME.set_manufacturer_code(1407);

const isobus::NAMEFilter filterVirtualTerminal(isobus::NAME::NAMEParameters::FunctionCode, static_cast<std::uint8_t>(isobus::NAME::Function::VirtualTerminal));
const std::vector<isobus::NAMEFilter> vtNameFilters = { filterVirtualTerminal };
Expand Down Expand Up @@ -495,7 +494,6 @@ Here's the final code for this example:
isobus::NAME TestDeviceNAME(0);

//! Make sure you change these for your device!!!!
//! This is an example device that is using a manufacturer code that is currently unused at time of writing
TestDeviceNAME.set_arbitrary_address_capable(true);
TestDeviceNAME.set_industry_group(1);
TestDeviceNAME.set_device_class(0);
Expand All @@ -504,7 +502,7 @@ Here's the final code for this example:
TestDeviceNAME.set_ecu_instance(0);
TestDeviceNAME.set_function_instance(0);
TestDeviceNAME.set_device_class_instance(0);
TestDeviceNAME.set_manufacturer_code(64);
TestDeviceNAME.set_manufacturer_code(1407);

std::vector<std::uint8_t> testPool = isobus::IOPFileInterface::read_iop_file("VT3TestPool.iop");

Expand Down
Loading