{
  "id": "howmanyoliversarethere/micropython-8encoder",
  "name": "micropython-8encoder",
  "prettyName": "micropython-8encoder",
  "description": "A MicroPython library for the M5 8Encoder.",
  "version": "",
  "author": "howmanyoliversarethere",
  "license": "MIT",
  "tags": [],
  "status": "VALID",
  "official": false,
  "source": "https://github.com/howmanyoliversarethere/micropython-8encoder",
  "updatedAt": "2026-09-27T07:00:16.347Z",
  "page": "https://checkmim.com/packages/howmanyoliversarethere+micropython-8encoder",
  "createdAt": "2025-05-27T04:29:53.612Z",
  "submittedBy": "oliverr",
  "install": {
    "mpremote": "mpremote mip install github:howmanyoliversarethere/micropython-8encoder",
    "mip": "import mip; mip.install(\"github:howmanyoliversarethere/micropython-8encoder\")"
  },
  "readme": "# M5 8Encoder\n\nThis is a MicroPython library for the [M5 8-Encoder](https://shop.m5stack.com/products/8-encoder-unit-stm32f030).\n\nFeatures:\n\n- ✅ Read encoder counter values\n- ✅ Read encoder increment values\n- ✅ Reset counter values\n- ✅ Read button values\n- ✅ Read switch value\n- ✅ Set LEDs\n- ✅ Read firmware version\n\n## Usage\n\n```python\nfrom machine import Pin, SoftI2C\nfrom m5_8encoder import M5_8Encoder\n\ni2c = SoftI2C(sda=Pin(SDA_PIN_NUM), scl=Pin(SCL_PIN_NUM), freq=100000)\nencoder = M5_8Encoder(i2c)\n```\n\nSee the `examples` folder for a basic example of how to utilise the `M5_8Encoder` object, and see `m5_8encoder.py` for the class definition and all of the available methods.\nYou will need to ensure you're setting SDA and SCL pin numbers correctly, and note that the examples here use the `SoftI2C` module but you could also use `I2C` (hardware I2C instead of software I2C) depending on your port / board.\n"
}