feetme 0.1.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
feetme-0.1.1/LICENSE ADDED
@@ -0,0 +1,174 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
feetme-0.1.1/PKG-INFO ADDED
@@ -0,0 +1,104 @@
1
+ Metadata-Version: 2.4
2
+ Name: feetme
3
+ Version: 0.1.1
4
+ Summary: Async Python client for FeetMe BLE pressure insoles
5
+ Author: Elesdes
6
+ Author-email: Elesdes <elesdes404@gmail.com>
7
+ License-Expression: Apache-2.0
8
+ License-File: LICENSE
9
+ Classifier: Programming Language :: Python :: 3
10
+ Classifier: Operating System :: OS Independent
11
+ Classifier: Framework :: AsyncIO
12
+ Requires-Dist: bleak>=0.22
13
+ Requires-Python: >=3.10
14
+ Project-URL: Repository, https://github.com/Elesdes/FeetMe-py
15
+ Project-URL: Issues, https://github.com/Elesdes/FeetMe-py/issues
16
+ Description-Content-Type: text/markdown
17
+
18
+ # feetme
19
+
20
+ [![GitHub License](https://img.shields.io/github/license/Elesdes/FeetMe-py)](LICENSE)
21
+ [![PyPI](https://img.shields.io/pypi/v/feetme)](https://pypi.org/project/feetme/)
22
+
23
+ > [!WARNING]
24
+ > This project is in early development and is not yet ready for production use.
25
+
26
+ ## Overview
27
+
28
+ Async Python client for FeetMe BLE pressure insoles (protocol 3), built on [bleak](https://github.com/hbldh/bleak).
29
+ It scans for insoles, reads device info, and streams pressure, IMU and stride data.
30
+
31
+ ## Setup
32
+
33
+ ### Requirements
34
+
35
+ - Python 3.10+
36
+ - FeetMe soles
37
+
38
+ ### Recommended Setup
39
+
40
+ ```bash
41
+ uv add feetme # or: pip install feetme
42
+ ```
43
+
44
+ ## Usage
45
+
46
+ CLI:
47
+
48
+ ```bash
49
+ feetme scan
50
+ feetme info 1441
51
+ feetme stream 1441 --mode raw16 --seconds 10 --csv out.csv
52
+ ```
53
+
54
+ `TARGET` is a BLE address or the insole number printed in its name ("FeetMe 1441 44R").
55
+
56
+ Library:
57
+
58
+ ```python
59
+ import asyncio
60
+ from feetme import Mode, find_insole
61
+
62
+ async def main():
63
+ async with await find_insole("1441") as insole:
64
+ print(await insole.get_battery())
65
+ insole.add_listener(print)
66
+ await insole.set_mode(Mode.RAW16)
67
+ await asyncio.sleep(5)
68
+
69
+ asyncio.run(main())
70
+ ```
71
+
72
+ ## Maintainers
73
+
74
+ ### Releasing a new version
75
+
76
+ 1. Bump the version in `pyproject.toml` and commit it to `main`:
77
+
78
+ ```bash
79
+ uv version --bump patch # or minor / major
80
+ git commit -am "chore: release v$(uv version --short)"
81
+ git push origin main
82
+ ```
83
+
84
+ 2. Tag the commit and push the tag:
85
+
86
+ ```bash
87
+ git tag v$(uv version --short)
88
+ git push origin v$(uv version --short)
89
+ ```
90
+
91
+ 3. The `release` workflow checks the tag matches the version, publishes the
92
+ package to [PyPI](https://pypi.org/project/feetme/), and creates a GitHub
93
+ Release with the wheel and sdist attached.
94
+
95
+ ## License
96
+
97
+ This project is licensed under the Apache License (Version 2.0).
98
+
99
+ See the [LICENSE](LICENSE) file for details.
100
+
101
+ ## AI Usage Transparency
102
+
103
+ This project uses AI tools to assist with development.
104
+ For more details, see the [AI Usage Disclosure](AI_USAGE.md) file.
feetme-0.1.1/README.md ADDED
@@ -0,0 +1,87 @@
1
+ # feetme
2
+
3
+ [![GitHub License](https://img.shields.io/github/license/Elesdes/FeetMe-py)](LICENSE)
4
+ [![PyPI](https://img.shields.io/pypi/v/feetme)](https://pypi.org/project/feetme/)
5
+
6
+ > [!WARNING]
7
+ > This project is in early development and is not yet ready for production use.
8
+
9
+ ## Overview
10
+
11
+ Async Python client for FeetMe BLE pressure insoles (protocol 3), built on [bleak](https://github.com/hbldh/bleak).
12
+ It scans for insoles, reads device info, and streams pressure, IMU and stride data.
13
+
14
+ ## Setup
15
+
16
+ ### Requirements
17
+
18
+ - Python 3.10+
19
+ - FeetMe soles
20
+
21
+ ### Recommended Setup
22
+
23
+ ```bash
24
+ uv add feetme # or: pip install feetme
25
+ ```
26
+
27
+ ## Usage
28
+
29
+ CLI:
30
+
31
+ ```bash
32
+ feetme scan
33
+ feetme info 1441
34
+ feetme stream 1441 --mode raw16 --seconds 10 --csv out.csv
35
+ ```
36
+
37
+ `TARGET` is a BLE address or the insole number printed in its name ("FeetMe 1441 44R").
38
+
39
+ Library:
40
+
41
+ ```python
42
+ import asyncio
43
+ from feetme import Mode, find_insole
44
+
45
+ async def main():
46
+ async with await find_insole("1441") as insole:
47
+ print(await insole.get_battery())
48
+ insole.add_listener(print)
49
+ await insole.set_mode(Mode.RAW16)
50
+ await asyncio.sleep(5)
51
+
52
+ asyncio.run(main())
53
+ ```
54
+
55
+ ## Maintainers
56
+
57
+ ### Releasing a new version
58
+
59
+ 1. Bump the version in `pyproject.toml` and commit it to `main`:
60
+
61
+ ```bash
62
+ uv version --bump patch # or minor / major
63
+ git commit -am "chore: release v$(uv version --short)"
64
+ git push origin main
65
+ ```
66
+
67
+ 2. Tag the commit and push the tag:
68
+
69
+ ```bash
70
+ git tag v$(uv version --short)
71
+ git push origin v$(uv version --short)
72
+ ```
73
+
74
+ 3. The `release` workflow checks the tag matches the version, publishes the
75
+ package to [PyPI](https://pypi.org/project/feetme/), and creates a GitHub
76
+ Release with the wheel and sdist attached.
77
+
78
+ ## License
79
+
80
+ This project is licensed under the Apache License (Version 2.0).
81
+
82
+ See the [LICENSE](LICENSE) file for details.
83
+
84
+ ## AI Usage Transparency
85
+
86
+ This project uses AI tools to assist with development.
87
+ For more details, see the [AI Usage Disclosure](AI_USAGE.md) file.
@@ -0,0 +1,29 @@
1
+ [project]
2
+ name = "feetme"
3
+ version = "0.1.1"
4
+ description = "Async Python client for FeetMe BLE pressure insoles"
5
+ readme = "README.md"
6
+ license = "Apache-2.0"
7
+ license-files = ["LICENSE"]
8
+ requires-python = ">=3.10"
9
+ dependencies = ["bleak>=0.22"]
10
+ classifiers = [
11
+ "Programming Language :: Python :: 3",
12
+ "Operating System :: OS Independent",
13
+ "Framework :: AsyncIO",
14
+ ]
15
+
16
+ [[project.authors]]
17
+ name = "Elesdes"
18
+ email = "elesdes404@gmail.com"
19
+
20
+ [project.urls]
21
+ Repository = "https://github.com/Elesdes/FeetMe-py"
22
+ Issues = "https://github.com/Elesdes/FeetMe-py/issues"
23
+
24
+ [project.scripts]
25
+ feetme = "feetme.cli:main"
26
+
27
+ [build-system]
28
+ requires = ["uv_build>=0.11.2,<0.12.0"]
29
+ build-backend = "uv_build"
@@ -0,0 +1,26 @@
1
+ [project]
2
+ name = "feetme"
3
+ version = "0.1.1"
4
+ description = "Async Python client for FeetMe BLE pressure insoles"
5
+ readme = "README.md"
6
+ license = "Apache-2.0"
7
+ license-files = ["LICENSE"]
8
+ authors = [{ name = "Elesdes", email = "elesdes404@gmail.com" }]
9
+ requires-python = ">=3.10"
10
+ dependencies = ["bleak>=0.22"]
11
+ classifiers = [
12
+ "Programming Language :: Python :: 3",
13
+ "Operating System :: OS Independent",
14
+ "Framework :: AsyncIO",
15
+ ]
16
+
17
+ [project.urls]
18
+ Repository = "https://github.com/Elesdes/FeetMe-py"
19
+ Issues = "https://github.com/Elesdes/FeetMe-py/issues"
20
+
21
+ [project.scripts]
22
+ feetme = "feetme.cli:main"
23
+
24
+ [build-system]
25
+ requires = ["uv_build>=0.11.2,<0.12.0"]
26
+ build-backend = "uv_build"
@@ -0,0 +1,10 @@
1
+ """Python client for FeetMe BLE pressure insoles."""
2
+ from .client import Conflict, FeetMeError, FeetMeInsole, InsoleNotFound, discover, find_insole
3
+ from .constants import Mode, Side
4
+ from .pair import InsolePair
5
+ from .protocol import ProtocolError
6
+
7
+ __all__ = [
8
+ "Conflict", "FeetMeError", "FeetMeInsole", "InsoleNotFound", "InsolePair",
9
+ "Mode", "ProtocolError", "Side", "discover", "find_insole",
10
+ ]
@@ -0,0 +1,103 @@
1
+ """Command line: feetme scan | info TARGET | stream TARGET --mode raw16 --seconds 10 --csv out.csv
2
+
3
+ TARGET is a BLE address or the insole number printed in its name ("FeetMe 1441 44R").
4
+ """
5
+ from __future__ import annotations
6
+
7
+ import argparse
8
+ import asyncio
9
+ import csv
10
+ import dataclasses
11
+ import json
12
+ import sys
13
+
14
+ from . import FeetMeError, Mode, find_insole
15
+ from .client import discover
16
+ from .models import HybridSample, ImuSample, PressureSample, RawPressureSample, Stride
17
+
18
+
19
+ async def _scan(args) -> None:
20
+ for dev, info in await discover(args.timeout):
21
+ print(f"{dev.address} #{info.number} {info.side.name:<5} size {info.size} "
22
+ f"protocol {info.protocol_version} battery {info.battery_percent}%")
23
+
24
+
25
+ async def _info(args) -> None:
26
+ async with await find_insole(args.target, timeout=args.timeout) as ins:
27
+ out = {
28
+ "address": ins.address,
29
+ "advertisement": dataclasses.asdict(ins.advertisement) if ins.advertisement else None,
30
+ "mac_address": ins.mac_address,
31
+ "versions": dataclasses.asdict(ins.versions),
32
+ "battery": dataclasses.asdict(await ins.get_battery()),
33
+ "rtc": dataclasses.asdict(await ins.get_rtc_status()),
34
+ "imu_config": dataclasses.asdict(await ins.get_imu_config()),
35
+ "step_counter": await ins.get_step_counter(),
36
+ "power_mode": await ins.get_power_mode(),
37
+ "synchro": dataclasses.asdict(await ins.get_synchro_status()),
38
+ "capa_offsets": dataclasses.asdict(await ins.get_capa_offsets()),
39
+ "intercom_paired_to": await ins.get_intercom_pairing(),
40
+ }
41
+ print(json.dumps(out, indent=2, default=lambda o: o.hex() if isinstance(o, bytes) else str(o)))
42
+
43
+
44
+ def _row(rec) -> tuple[str, list] | None:
45
+ if isinstance(rec, ImuSample):
46
+ return "imu", [rec.tick, *rec.gyro, *rec.accel, rec.accel_fs_g, rec.gyro_fs_dps]
47
+ if isinstance(rec, RawPressureSample):
48
+ return "raw_pressure", [rec.tick, *rec.counts]
49
+ if isinstance(rec, PressureSample):
50
+ return "pressure", [rec.tick, *(round(v, 4) for v in rec.pressures)]
51
+ if isinstance(rec, HybridSample):
52
+ return "hybrid", [rec.tick, *rec.position, rec.capa_sum, rec.cop_y, int(rec.toe_off)]
53
+ if isinstance(rec, Stride):
54
+ return "stride", [rec.timestamp_ms, rec.heel_strike_ms, rec.toe_off_ms, rec.next_heel_strike_ms,
55
+ rec.stride_length, rec.cadence, rec.algo_flag.name]
56
+ return None
57
+
58
+
59
+ async def _stream(args) -> None:
60
+ mode = Mode[args.mode.upper()]
61
+ out = open(args.csv, "w", newline="") if args.csv else sys.stdout
62
+ writer = csv.writer(out)
63
+ counts: dict[str, int] = {}
64
+
65
+ def on_record(rec) -> None:
66
+ r = _row(rec)
67
+ if r is None:
68
+ return
69
+ kind, values = r
70
+ counts[kind] = counts.get(kind, 0) + 1
71
+ writer.writerow([kind, *values])
72
+
73
+ async with await find_insole(args.target, timeout=args.timeout) as ins:
74
+ ins.add_listener(on_record)
75
+ await ins.set_mode(mode)
76
+ await asyncio.sleep(args.seconds)
77
+ await ins.set_mode(Mode.METRIC)
78
+ if args.csv:
79
+ out.close()
80
+ print(f"records: {counts}", file=sys.stderr)
81
+
82
+
83
+ def main(argv: list[str] | None = None) -> None:
84
+ ap = argparse.ArgumentParser(prog="feetme")
85
+ ap.add_argument("--timeout", type=float, default=8.0, help="scan timeout (s)")
86
+ sub = ap.add_subparsers(dest="cmd", required=True)
87
+ sub.add_parser("scan")
88
+ i = sub.add_parser("info")
89
+ i.add_argument("target")
90
+ s = sub.add_parser("stream")
91
+ s.add_argument("target")
92
+ s.add_argument("--mode", default="raw16", choices=["raw16", "dynamic", "hybrid", "metric"])
93
+ s.add_argument("--seconds", type=float, default=10)
94
+ s.add_argument("--csv")
95
+ args = ap.parse_args(argv)
96
+ try:
97
+ asyncio.run({"scan": _scan, "info": _info, "stream": _stream}[args.cmd](args))
98
+ except FeetMeError as e:
99
+ sys.exit(f"error: {e}")
100
+
101
+
102
+ if __name__ == "__main__":
103
+ main()