| Name | ff-ad5m-audio JSON |
| Version |
0.2
JSON |
| download |
| home_page | |
| Summary | Audio library for FlashForge Adventurer 5M using the pwm device as audio output to play frequencies and midi files. |
| upload_time | 2024-03-01 10:34:18 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | |
| keywords |
flashforge
adventurer
5m
ad5m
audio
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# FlashForge Adventurer 5M Audio library
Can be used to play midi files and frequencies on the speaker of the FlashForge Adventurer 5M (pro).
Can also be used to play on other linux devices which use a simple PWM driver as audio device.
Note: midi files online are a mess, you might have to seek a while. Try finding the channel with piano or other keytype instrument, usually works best.
Usage:
```
$ audio --help
usage: FF AD5M Audio 'player' [-h] [-f FREQUENCY] [-d DURATION] [-c CHANNEL] [-m MIDIFILE] [-p PWM] [-v] [--nopwm]
{midi,freq,disable}
This program can either play a midi file, single track, single note, single chanel or a frequency for a specific duration
positional arguments:
{midi,freq,disable} Either midi or freq
options:
-h, --help show this help message and exit
-f FREQUENCY, --frequency FREQUENCY
Frequency
-d DURATION, --duration DURATION
Duration of frequency
-c CHANNEL, --channel CHANNEL
Channel of track to play
-m MIDIFILE, --midifile MIDIFILE
Midi filename
-p PWM, --pwm PWM pwm device to use
-v, --verbose Be verbose (might slow down playback in case of heavy pitch changes)
--nopwm Disable PWM driver, used for testing midi file reading
See https://github.com/xblax/flashforge_adm5_klipper_mod and https://github.com/consp/flashforge_adm5_audio
```
# License
This work is licensed under CC BY-NC 4.0 (https://creativecommons.org/licenses/by-nc/4.0/)
# Known issues
* Using verbose can significanly slow down your playback on slower machines
* Midi files get load into memory completely, if you have little available be wary of large midi files.
* Since the pwm device is monotone, channels with polytone audio will not sound proper. There is no way to do anything about this, seek monotone channels.
* Only pwmchip0 can be used at this time, the FF Ad5M only has one.
Raw data
{
"_id": null,
"home_page": "",
"name": "ff-ad5m-audio",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Tristan Timmermans <none@yourbusiness.nowhere>",
"keywords": "flashforge,adventurer,5m,ad5m,audio",
"author": "",
"author_email": "Tristan Timmermans <none@yourbusiness.nowhere>",
"download_url": "https://files.pythonhosted.org/packages/ac/46/17c26e0c1742127c486ac3ca7ddc349f628b0b58734afdb5dbf6fc03e9d2/ff-ad5m-audio-0.2.tar.gz",
"platform": null,
"description": "# FlashForge Adventurer 5M Audio library\n\nCan be used to play midi files and frequencies on the speaker of the FlashForge Adventurer 5M (pro).\nCan also be used to play on other linux devices which use a simple PWM driver as audio device.\n\nNote: midi files online are a mess, you might have to seek a while. Try finding the channel with piano or other keytype instrument, usually works best.\n\nUsage:\n\n```\n$ audio --help\nusage: FF AD5M Audio 'player' [-h] [-f FREQUENCY] [-d DURATION] [-c CHANNEL] [-m MIDIFILE] [-p PWM] [-v] [--nopwm]\n {midi,freq,disable}\n\nThis program can either play a midi file, single track, single note, single chanel or a frequency for a specific duration\n\npositional arguments:\n {midi,freq,disable} Either midi or freq\n\noptions:\n -h, --help show this help message and exit\n -f FREQUENCY, --frequency FREQUENCY\n Frequency\n -d DURATION, --duration DURATION\n Duration of frequency\n -c CHANNEL, --channel CHANNEL\n Channel of track to play\n -m MIDIFILE, --midifile MIDIFILE\n Midi filename\n -p PWM, --pwm PWM pwm device to use\n -v, --verbose Be verbose (might slow down playback in case of heavy pitch changes)\n --nopwm Disable PWM driver, used for testing midi file reading\n\nSee https://github.com/xblax/flashforge_adm5_klipper_mod and https://github.com/consp/flashforge_adm5_audio\n```\n\n# License\n\nThis work is licensed under CC BY-NC 4.0 (https://creativecommons.org/licenses/by-nc/4.0/)\n\n# Known issues\n\n* Using verbose can significanly slow down your playback on slower machines\n* Midi files get load into memory completely, if you have little available be wary of large midi files.\n* Since the pwm device is monotone, channels with polytone audio will not sound proper. There is no way to do anything about this, seek monotone channels.\n* Only pwmchip0 can be used at this time, the FF Ad5M only has one.\n",
"bugtrack_url": null,
"license": "",
"summary": "Audio library for FlashForge Adventurer 5M using the pwm device as audio output to play frequencies and midi files.",
"version": "0.2",
"project_urls": null,
"split_keywords": [
"flashforge",
"adventurer",
"5m",
"ad5m",
"audio"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "282e4114554644b2e2cfca5d32e9c6de22f068973e6f0b90531790cc31ab28d2",
"md5": "3ed4f4c487aa73ab9ae20f994eb304f8",
"sha256": "d2488e937a1c4e5a46b073accd626116af125bc6c86eea394ea195e0ed28a4cd"
},
"downloads": -1,
"filename": "ff_ad5m_audio-0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3ed4f4c487aa73ab9ae20f994eb304f8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 11264,
"upload_time": "2024-03-01T10:34:16",
"upload_time_iso_8601": "2024-03-01T10:34:16.764989Z",
"url": "https://files.pythonhosted.org/packages/28/2e/4114554644b2e2cfca5d32e9c6de22f068973e6f0b90531790cc31ab28d2/ff_ad5m_audio-0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ac4617c26e0c1742127c486ac3ca7ddc349f628b0b58734afdb5dbf6fc03e9d2",
"md5": "3a901c17db44283a7627768402328014",
"sha256": "76130172ee6aa67a126c526ee5d69c92856b43356de82644343b7ac23243f4a8"
},
"downloads": -1,
"filename": "ff-ad5m-audio-0.2.tar.gz",
"has_sig": false,
"md5_digest": "3a901c17db44283a7627768402328014",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 10604,
"upload_time": "2024-03-01T10:34:18",
"upload_time_iso_8601": "2024-03-01T10:34:18.713961Z",
"url": "https://files.pythonhosted.org/packages/ac/46/17c26e0c1742127c486ac3ca7ddc349f628b0b58734afdb5dbf6fc03e9d2/ff-ad5m-audio-0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-01 10:34:18",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "ff-ad5m-audio"
}
