euphony-io / euphony-hub-collector Goto Github PK

Does the feature exist in the most recent commit?

• It doesn't exist.

Describe the proposal

User can login with their account at settings page

Why do we need this feature?

With euphony-hub-collector, raw data will be collected and it should be uploaded to github.
To upload data automatically, we should support github login feature at SettingsView.

Fianl Goal: If user logged in with github account, raw data will be sent to their forked euphony-hub repository (auto-commit).

Anything else?

Need to investigate github API related to login

Feature Description

Now, euphony-collector supports speaker+listener mode, so data transmission is almost success.
To collect non-ideal data, euphony-collector should also support listener mode.

Let's say there are 2 devices

• device A: euphony-speaker (it sends "abc" to device B)
• device B: euphony-collector (it listens data from device A)
  • Case1: listen result can be "abc" -> it is success, so euphony-collector should save this result
  • Case2: listen result can be "ab" -> it is fail, so euphony-collector should discard this result

Then, euphony-collector should support feature like below

• euphony-collector can listen through another devices
• euphony-collector should receive data from other devices using another communication like bluetooth
• To check whether the received data is correct, euphony-collector should compare bluetooth result and euphony listen result
• After comparing the result, euphony-collector should decide whether to save the data or not

Decision

• Which communication is proper to send data? Is bluetooth the best?

What is the improvement or update you wish to see?

We will have many contributors in euphony-collector, so it is nice to support contribution guide document.

Is there any context that might help us understand?

Generally, contribution guide is CONTRIBUTING.md in repository, and it is linked in README.md.
We need to compare other open source's document and apply ours.

Does the docs page already exist? Please link to it.

No

Description

There's no "feature request" issue template, so it is hard to suggest features.
We need to compare other open source's issue template and apply ours.
If you feel hard to figure out how to resolve this issue, please refer #9 and check @designe 's comments.

Description

In setting page, we can change audio parameters such as modulation type, base type and so on, but we cannot utilize these parameters because euphony v0.7.1.6 only supports default parameters.

Default parameters:

• Modulation Type: FSK
• Base Type: Base16
• Charset Type: ASCII

If euphony supports being able to use rxManager and txManager by changing these parameters in the future, we will use this feature at setting page.

If we change audio parameters in setting page, we can use euphony with these parameters in collector page.

Description

You may have questions about the euphony-collector, so it is good to support issue template for questions.
We need to compare other open source's issue template and apply ours.
If you feel hard to figure out how to resolve this issue, please refer #9 and check @designe 's comments.

Description

There's no bug report issue template, so it is hard to report bug.
We need to compare other open source's issue template and apply ours.

What is the improvement or update you wish to see?

There's no "docs request" issue template, so it is hard to request documentation.

Is there any context that might help us understand?

We need to compare other open source's issue template and apply ours.
If you feel hard to figure out how to resolve this issue, please refer #9 and check @designe 's comments.

Does the docs page already exist? Please link to it.

No

Does the feature exist in the most recent commit?

• It doesn't exist

Describe the proposal

We need to support dark mode theme at euphony-hub-collector.

Why do we need this feature?

Now, when we launch euphony-hub-collector with dark mode, it is hard to recognize.

What is the improvement or update you wish to see?

To represent what euphony-hub-collector is doing, README document is needed.

Is there any context that might help us understand?

Generally, README document contains below items.

• What is this repository for? (background, brief description)
• How to execute
• License information
• How to contribute
• ...

Does the docs page already exist? Please link to it.

No

Description

Now euphony-collector supports euphony v0.7.1.6, but v0.8 is released, and changes are listed in this link.
v0.8 supports a lot of features, so if we upgrade version, we can add more functionalities in euphony-collector.

Does the feature exist in the most recent commit?

• It doesn't exist

Describe the proposal

In collector page, we can send and receive data using euphony library.
We can support two types of raw data - pcm and wav (data type can be set in settings page)
If listening result is success, we should save this data to our database and show in result page.

Now, euphony library is already using AudioRecord, so it should support being able to extract raw recording data.
This issue can be resolved after that feature is released.

Why do we need this feature?

We can use raw data as AI dataset.

Description

This repository's package is co.jbear.euphony_hub, but we need to change it to co.jbear.euphony_hub_collector, because the word hub usually serves as datastore (e.g. pytorch hub, tf hub)

This repository is data collector for euphony-hub, so its package should be euphony_hub_collector.

Description

We will have many contributors in euphony-collector, so it is nice to support pull request template for good communication.
Contents can be "checklist", "pr type" and so on.
We need to compare other open source's template and apply ours.
If you feel hard to figure out how to resolve this issue, please refer #9 and check @designe 's comments.

Does the feature exist in the most recent commit?

• It doesn't exist.

Describe the proposal

This repository's package is co.jbear.euphony_hub_collector

but we need to change it to co.euphony.euphony_hub_collector
because we need to unify the package name with euphony project
https://github.com/euphony-io/euphony/tree/master/euphony/src/main/java/co/euphony

Why do we need this feature?

package name from co.jbear.euphony_hub_collector to co.euphony.euphony_hub_collector

Describe alternatives you've considered

Anything else?

No response

Description

If pull request is created to master branch, to check whether this PR has problem, it is nice to make CI process.
Generally, github action is .github/workflows/xxx.yml in repository.
Feel free to suggest filename for yml and what steps should be included in CI.

Is there an existing issue for this?

• I have searched the existing issues.

Would you like to work on the issue?

• Assign this issue to me.

Describe the bug

Github Action also runs when markdown files are modified. But markdown files don't affect the build process, so it is unnecessary.

Expected Behavior

When markdown files are changed, github action should not run.

Environment

None

Steps to reproduce

None

Anything else?

No response