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

how to use the camara’s api #55

Closed
saiyujs opened this issue Dec 4, 2023 · 4 comments
Closed

how to use the camara’s api #55

saiyujs opened this issue Dec 4, 2023 · 4 comments
Labels
tests Indicate an issue with API tests

Comments

@saiyujs
Copy link

saiyujs commented Dec 4, 2023

Problem description
how to use the camara’s api with my program?
for example, I want to get some informations from the home's modem. I will use the tr069 to get wifi info. now can i use camara’s api(HomeDevicesQoD) to implement it?

@saiyujs saiyujs added the tests Indicate an issue with API tests label Dec 4, 2023
@jpengar
Copy link
Collaborator

jpengar commented Dec 5, 2023

@saiyujs What do you mean exactly by I want to get some informations from the home's modem?
And you say you want to use HomeDevicesQoD to implement it?

Please note that the functionality provided by HomeDevicesQoD API is the one described in the API specification:

Service Enabling Network Function API for QoS-on-demand (QoD) control applied to devices connected to the user's home network. API clients can request to change, on demand, the desired QoS behaviour for the IP traffic corresponding to a specific user home device. The QoS behaviour is determined by the Service Class provided by the API Client, which is mapped to a DSCP value according to RFC4594 guidelines.

Please refer to the API definition for further details:
https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/HomeDevicesQoD/release-0.2.0/code/API_definitions/home_devices_qod.yaml

@saiyujs
Copy link
Author

saiyujs commented Dec 6, 2023

the Camara Project is only responsible for defining APIs?The Telecom operators or other operators responsible for providing interface implementation?such as TM Forum Open APIs.
I haven't understand Camara Project Application scenarios.

My job is to be responsible for reading and writing modem data. so I would like to know more about it, thanks.

@jpengar
Copy link
Collaborator

jpengar commented Dec 11, 2023

the Camara Project is only responsible for defining APIs?The Telecom operators or other operators responsible for providing interface implementation?such as TM Forum Open APIs.
I haven't understand Camara Project Application scenarios.

@saiyujs What I see is that you actually have general questions and doubts about CAMARA Project and not specifically about the Home Devices QoD API. I recommend you to have a look at https://camaraproject.org/, CAMARA Project Confluence and Getting Started with CAMARA and CAMARA Q&A.

CAMARA is focused on the API definitions, which is the NBI of the operators to the API consumers. It's true that there are some subprojects where some operators also provide reference implementations like in QualityOnDemand.

My job is to be responsible for reading and writing modem data. so I would like to know more about it, thanks.

I understand, but the Home Devices QoD API does not provide this functionality and there is no such use case yet. It looks to me like you are actually looking for implementation details in SBI, which would be outside the scope of the API definition.

@saiyujs
Copy link
Author

saiyujs commented Dec 12, 2023

thanks!!

@saiyujs saiyujs closed this as completed Dec 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tests Indicate an issue with API tests
Projects
None yet
Development

No branches or pull requests

2 participants