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.

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

Added MQTTv5 UTransport methods #1

Open
wants to merge 10 commits into
base: main
Choose a base branch
from

Conversation

matthewd0123
Copy link

  • Added UTransport (send, registerlistener, unregisterlistener) methods
  • Added pub/sub examples for testing.
  • Updated README with information on installation and use.
  • Added necessary legal/contributing documents
  • Added publish workflow

* Added UTransport (send, registerlistener, unregisterlistener) methods
* Added pub/sub examples for testing.
* Updated README with information on installation and use.
* Added necessary legal/contributing documents
* Added publish workflow
@matthewd0123
Copy link
Author

#2

@matthewd0123 matthewd0123 marked this pull request as draft March 19, 2024 03:45
README.adoc Show resolved Hide resolved
All Properties in UAttributes will be mapped to MQTT Publish Properties. As Such, I have added this into the UTransport.

nb: I am using the in-built Base64ProtobufSerializer() methods to serialize and deserialize the UUIDs (id and reqid). This implementation may change.
* Testing Send and RegisterListener using paho.mqtt FakeBroker and Pytest
* Support all userproperties mapping to UAttributes
@matthewd0123 matthewd0123 marked this pull request as ready for review May 13, 2024 12:32
@@ -0,0 +1,100 @@
# Copyright (C) 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file and some other files in test have this license. Is this the correct license?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, it refers to the EPL but uProtocol uses the Apache Software License 2.0. It should be

# SPDX-FileCopyrightText: 2021 Contributors to the Eclipse Foundation
#
# See the NOTICE file(s) distributed with this work for additional
# information regarding copyright ownership.
#
# This program and the accompanying materials are made available under the
# terms of the Apache License Version 2.0 which is available at
# https://www.apache.org/licenses/LICENSE-2.0
#
# SPDX-License-Identifier: Apache-2.0

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@devkelley @sophokles73 for some of the files in tests folder, I have brought in test code from the paho.mqtt.python project, which is an eclipse project (https://github.com/eclipse/paho.mqtt.python/tree/master/tests). I have used the licensing that they used in some of their files. Can one of you let me know if there is a different way to reference that I'm using their code, or if it's even allowed to take code from other eclipse projects?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, that is a good question. I am sure it depends partly on the EPL-2.0 license and what that stipulates. This FAQ seems to imply that it is okay to include as long as you include where you got the code from and the license (https://www.eclipse.org/legal/epl-2.0/faq.php). That being said it would probably be good to verify with someone from eclipse foundation

* Update MQTT Client and examples to 1.5.8
* Format to align with ruff standards
* Add linter to workflow
@matthewd0123 matthewd0123 force-pushed the matthewd0123/implement-utransport-methods branch from 6b921be to 7497a4d Compare July 16, 2024 15:26
@matthewd0123 matthewd0123 force-pushed the matthewd0123/implement-utransport-methods branch from ad025f7 to 11c60aa Compare July 31, 2024 18:16
.github/ruff.toml Outdated Show resolved Hide resolved
.github/workflows/lint.yml Outdated Show resolved Hide resolved
.github/workflows/python-publish.yml Outdated Show resolved Hide resolved
.gitignore Outdated Show resolved Hide resolved
examples/docker_mosquitto/docker-compose.yml Outdated Show resolved Hide resolved
examples/docker_mosquitto/mosquitto/config/mosquitto.conf Outdated Show resolved Hide resolved
* Add EOL to files in repository that were missing them.
@neelam-kushwah neelam-kushwah linked an issue Aug 1, 2024 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In Review
Development

Successfully merging this pull request may close these issues.

Implement UTransport for MQTTv5
3 participants